Get Table Records with ServiceNow API on New Bot Command Received (Instant) from Telegram Bot API

Pipedream makes it easy to connect APIs for ServiceNow, Telegram Bot and 2,000+ other apps remarkably fast.

Trigger workflow on

New Bot Command Received (Instant) from the Telegram Bot API

Next, do this

Get Table Records with the ServiceNow API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Telegram Bot trigger and ServiceNow action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Bot Command Received (Instant) trigger
1. Connect your Telegram Bot account
2. Select one or more Commands
Configure the Get Table Records action
1. Connect your ServiceNow account
2. Configure table_name
3. Optional- Select a api_version
4. Optional- Select a request_format
5. Optional- Select a response_format
6. Optional- Configure sysparm_query
7. Optional- Select a sysparm_display_value
8. Optional- Configure sysparm_exclude_reference_link
9. Optional- Configure sysparm_suppress_pagination_header
10. Optional- Configure sysparm_fields
11. Optional- Configure sysparm_limit
12. Optional- Configure sysparm_view
13. Optional- Configure sysparm_query_category
14. Optional- Configure sysparm_query_no_domain
15. Optional- Configure sysparm_no_count
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Bot Command Received (Instant) on Telegram Bot

Description:Emit new event each time a Telegram Bot command is received.

Version:0.0.5

Key:telegram_bot_api-new-bot-command-received

View on GitHub

New Bot Command Received (Instant) Overview#

Telegram Bots can respond to Slash commands. For instance, you can add a /hi or /help command to your Telegram bot to help users learn how to use your bot.

Trigger Code#

import base from "../common/webhooks.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "telegram_bot_api-new-bot-command-received",
  name: "New Bot Command Received (Instant)",
  description: "Emit new event each time a Telegram Bot command is received.",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    commands: {
      propDefinition: [
        base.props.telegramBotApi,
        "commands",
      ],
    },
  },
  methods: {
    ...base.methods,
    getMeta(event, message) {
      return {
        id: event.update_id,
        summary: message.text,
        ts: new Date(message.edit_date ?? message.date),
      };
    },
    getEventTypes() {
      return [
        "message",
        "edited_message",
      ];
    },
    processEvent(event) {
      const message = event.edited_message ?? event.message;

      if (!message?.text) {
        console.log("Skipping message that isn’t a bot command");

        return;
      }

      const command = message.text.split(" ")[0];

      if (typeof this.commands === "string") {
        this.commands = JSON.parse(this.commands);
      }

      const foundCmd = this.commands.some((cmd) => command.includes(cmd));
      if (!foundCmd) {
        return;
      }

      this.$emit(event, this.getMeta(event, message));
    },
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Telegram Bot	`telegramBotApi`	`app`	This component uses the Telegram Bot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Commands	`commands`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Telegram Bot uses API keys for authentication. When you connect your Telegram Bot account, Pipedream securely stores the keys so you can easily authenticate to Telegram Bot APIs in both code and no-code steps.

To use the Telegram Bot API, you must first create a new bot by chatting with the BotFather.

After you create your bot, copy the bot token and add it below.

About Telegram Bot#

Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.

Action#

Get Table Records on ServiceNow

Description:Retrieves multiple records for the specified table.

Version:0.3.1

Key:servicenow-get-table-records

View on GitHub

ServiceNow Overview#

The ServiceNow API enables developers to tap into the robust capabilities of ServiceNow's IT service management platform. With the API, you can create, read, update, and delete records, manage workflows, and integrate with other services. By leveraging these capabilities, you can automate routine tasks, sync data across multiple platforms, and enhance operational efficiencies.

Action Code#

// legacy_hash_id: a_wdid84
import { axios } from "@pipedream/platform";

export default {
  key: "servicenow-get-table-records",
  name: "Get Table Records",
  description: "Retrieves multiple records for the specified table.",
  version: "0.3.1",
  type: "action",
  props: {
    servicenow: {
      type: "app",
      app: "servicenow",
    },
    table_name: {
      type: "string",
      description: "The name of the table containing the records to retrieve.",
    },
    api_version: {
      type: "string",
      description: "API version number. Version numbers identify the endpoint version that a URI accesses. By specifying a version number in your URIs, you can ensure that future updates to the REST API do not negatively impact your integration. Use `lastest` to use the latest REST endpoint for your instance version.",
      optional: true,
      options: [
        "lastest",
        "v1",
        "v2",
      ],
    },
    request_format: {
      type: "string",
      description: "Format of REST request body",
      optional: true,
      options: [
        "application/json",
        "application/xml",
        "text/xml",
      ],
    },
    response_format: {
      type: "string",
      description: "Format of REST response body.",
      optional: true,
      options: [
        "application/json",
        "application/xml",
        "text/xml",
      ],
    },
    sysparm_query: {
      type: "string",
      optional: true,
    },
    sysparm_display_value: {
      type: "string",
      description: "Return field display values (true), actual values (false), or both (all) (default: false).",
      optional: true,
      options: [
        "true",
        "false",
        "all",
      ],
    },
    sysparm_exclude_reference_link: {
      type: "boolean",
      description: "True to exclude Table API links for reference fields (default: false).",
      optional: true,
    },
    sysparm_suppress_pagination_header: {
      type: "boolean",
      description: "True to supress pagination header (default: false).",
      optional: true,
    },
    sysparm_fields: {
      type: "string",
      description: "A comma-separated list of fields to return in the response.",
      optional: true,
    },
    sysparm_limit: {
      type: "string",
      description: "The maximum number of results returned per page (default: 10,000).",
      optional: true,
    },
    sysparm_view: {
      type: "string",
      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
      optional: true,
    },
    sysparm_query_category: {
      type: "string",
      description: "Name of the query category (read replica category) to use for queries.",
      optional: true,
    },
    sysparm_query_no_domain: {
      type: "boolean",
      description: "True to access data across domains if authorized (default: false).",
      optional: true,
    },
    sysparm_no_count: {
      type: "boolean",
      description: "Do not execute a select count(*) on table (default: false).",
      optional: true,
    },
  },
  async run({ $ }) {
  // See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#table-GET-id                    */

    if (!this.table_name) {
      throw new Error("Must provide table_name parameter.");
    }

    var apiVersion = "";
    if (this.api_version == "v1" || this.api_version == "v2") {
      apiVersion = this.api_version + "/";
    }

    return await axios($, {
      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}`,
      headers: {
        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
        "Accept": this.request_format || "application/json",
        "Content-Type": this.response_format || "application/json",
      },
      params: {
        sysparm_query: this.sysparm_query,
        sysparm_display_value: this.sysparm_display_value,
        sysparm_exclude_reference_link: this.sysparm_exclude_reference_link,
        sysparm_suppress_pagination_header: this.sysparm_suppress_pagination_header,
        sysparm_fields: this.sysparm_fields,
        sysparm_limit: this.sysparm_limit,
        sysparm_view: this.sysparm_view,
        sysparm_query_category: this.sysparm_query_category,
        sysparm_query_no_domain: this.sysparm_query_no_domain,
        sysparm_no_count: this.sysparm_no_count,
      },
    });
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
ServiceNow	`servicenow`	`app`	This component uses the ServiceNow app.
table_name	`table_name`	`string`	The name of the table containing the records to retrieve.
api_version	`api_version`	`string`	Select a value from the drop down menu:`lastestv1v2`
request_format	`request_format`	`string`	Select a value from the drop down menu:`application/jsonapplication/xmltext/xml`
response_format	`response_format`	`string`	Select a value from the drop down menu:`application/jsonapplication/xmltext/xml`
sysparm_query	`sysparm_query`	`string`
sysparm_display_value	`sysparm_display_value`	`string`	Select a value from the drop down menu:`truefalseall`
sysparm_exclude_reference_link	`sysparm_exclude_reference_link`	`boolean`	True to exclude Table API links for reference fields (default: false).
sysparm_suppress_pagination_header	`sysparm_suppress_pagination_header`	`boolean`	True to supress pagination header (default: false).
sysparm_fields	`sysparm_fields`	`string`	A comma-separated list of fields to return in the response.
sysparm_limit	`sysparm_limit`	`string`	The maximum number of results returned per page (default: 10,000).
sysparm_view	`sysparm_view`	`string`	Render the response according to the specified UI view (overridden by sysparm_fields).
sysparm_query_category	`sysparm_query_category`	`string`	Name of the query category (read replica category) to use for queries.
sysparm_query_no_domain	`sysparm_query_no_domain`	`boolean`	True to access data across domains if authorized (default: false).
sysparm_no_count	`sysparm_no_count`	`boolean`	Do not execute a select count(*) on table (default: false).

Action Authentication#

ServiceNow uses OAuth authentication. When you connect your ServiceNow account, Pipedream will open a popup window where you can sign into ServiceNow and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any ServiceNow API.

Pipedream requests the following authorization scopes when you connect your account: