Update Table Record with ServiceNow API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for ServiceNow, Slack and 1200+ other apps remarkably fast.

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Update Table Record with the ServiceNow API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Slack 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 Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
Configure the Update Table Record action
1. Connect your ServiceNow account
2. Configure table_name
3. Configure sys_id
4. Configure update_fields
5. Optional- Select a api_version
6. Optional- Select a request_format
7. Optional- Select a response_format
8. Optional- Configure x_no_response_body
9. Optional- Select a sysparm_display_value
10. Optional- Configure sysparm_fields
11. Optional- Configure sysparm_input_display_value
12. Optional- Select a sysparm_view
13. Optional- Configure sysparm_query_no_domain
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.11

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. When you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions, or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It just makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Here are some examples of automations you can build with Pipedream on Slack:

Automate posting updates to your team channel
Create a bot to answer common questions
Integrate with your existing tools and services
Build a custom dashboard to track your team's progress
Create a bot to handle scheduling and meeting requests
And much more!

Should I use the Slack or Slack Bot app on Pipedream?

The Slack app is the easiest and most convienent option to get started. It installs the official Pipedream bot into your Slack workspace with just a few clicks.

However, if you'd like to use your own bot registered with the Slack API, you can use the Slack Bot app instead.

The Slack Bot requires a bot token to allow your Pipedream workflows to authenticate as your bot. The extra set up steps allow you to list your custom bot on the Slack Marketplace, or install the bot on other workspaces as your bot's name instead of as Pipedream.

Getting Started

You can install the Pipedream Slack app in the Accounts section of your account, or directly in a workflow

Accounts

Visit https://pipedream.com/accounts.
Click on the Click Here To Connect An App button in the top-right.
Search for "Slack" among the list of apps, and select it.
This will open a new window asking you to allow Pipedream access to your Slack workspace. Choose the right workspace where you'd like to install the app, then click Allow.
That's it! You can now use this Slack account in any actions, or link it to any code step.

Within a workflow

Create a new workflow.
Select your trigger (HTTP, Cron, etc.).
Click on the + button below the trigger step, and search for "Slack".
Select the Send a Message action.
Click the Connect Account button near the top of the step. This will prompt you to select any existing Slack accounts you've previously authenticated with Pipedream, or you can select a New account. Clicking New opens a new window asking you to allow Pipedream access to your Slack workspace. Choose the right workspace where you'd like to install the app, then click Allow.
That's it! You can now connect to the Slack API using any of the Slack actions within a Pipedream workflow.

Troubleshooting

Please reach out to the Pipedream team with any technical issues or questions about the Slack integration. We're happy to help!

Trigger Code#

import common from "../common/base.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.11",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return event;
    },
  },
};

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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`nameCache`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots

Trigger Authentication#

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

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

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

Update Table Record on ServiceNow

Description:Updates the specified record with the name-value pairs included in the request body.

Version:0.1.1

Key:servicenow-update-table-record

View on GitHub

ServiceNow Overview#

Using the ServiceNow API, you can build a variety of powerful applications that
help you extend and enhance the capabilities of your ServiceNow implementation.
The possibilities are endless! You can:

Create custom pages and widgets that provide additional functionality and
data visualizations tailored to your needs
Automate user and business processes with the help of integration tools
Streamline production deployments and drive up efficiency with workflow
systems
Develop custom plugins to facilitate data exchange with other systems
Leverage machine learning to extract knowledge from large data sets and
create predictive models
Create interactive chatbots for providing support or collecting feedback
Generate custom reports for tracking performance and resource utilization
And much more!

No matter whether you are looking to extend existing features or build
something totally new, the ServiceNow API offers the perfect solution!

Getting Started

Before you can use the ServiceNow REST API from a workflow, you need to configure an OAuth app in your ServiceNow instance that will grant access tokens to your users and authenticate requests to its REST API.

In your ServiceNow instance, visit the Application Registry and create a new app, choosing the Create an OAuth API endpoint for external clients option.
Name it something memorable, then leave every other field blank or keep the defaults, except for the Redirect URL, which should be: https://api.pipedream.com/connect/oauth/oa_g2oiqA/callback. Your app should look something like this:

Next, you'll need to copy the client ID and secret generated in Step 2, and add another app. This time, select the option to Connect to a third party OAuth Provider.
Name this app something like Pipedream OAuth Validator, and add the client ID / secret from Step 2. Change the grant type to Authorization Code, and set the Token URL to oauth_token.do (without any hostname, this refers to the current instance). Finally, add the same Redirect URL as you did above: https://api.pipedream.com/connect/oauth/oa_g2oiqA/callback. This app's configuration should look something like this when complete:

Visit https://pipedream.com/accounts, and click the button labeled Click Here to Connect An App in the top-right. In the modal that appears, search for ServiceNow and select it. You'll be prompted to enter the client ID and client secret from Step 2 above, as well as the name of your instance. The instance name is the host portion of your instance's URL: that is, the dev98042 in https://dev98042.service-now.com/.

Press Connect in the bottom-right of the modal. This should open up a new window asking you to login to your ServiceNow instance. This authorizes Pipedream's access to your ServiceNow account, and you should be ready to connect to your instance's REST API!

Collectively, the two apps you configured in your ServiceNow instance allow your instance to issue new OAuth access tokens for the user who authenticated in Step 6. This allows Pipedream to retrieve a fresh access token before it makes requests to the ServiceNow REST API.

ServiceNow Authorization Reference

This ServiceNow doc describes the general flow we ask you to implement above. In that doc, the app you create in Step 2 is referred to as the client application, and the app in Step 4 is referred to as the OAuth provider application registry record.

Action Code#

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

export default {
  key: "servicenow-update-table-record",
  name: "Update Table Record",
  description: "Updates the specified record with the name-value pairs included in the request body.",
  version: "0.1.1",
  type: "action",
  props: {
    servicenow: {
      type: "app",
      app: "servicenow",
    },
    table_name: {
      type: "string",
      description: "The name of the table containing the record to update.",
    },
    sys_id: {
      type: "string",
      description: "Unique identifier of the record to update.",
    },
    update_fields: {
      type: "object",
      description: "An object with name-value pairs with the fields to update in the specified record.\n**Note:** All fields within a record may not be available for update. For example, fields that have a prefix of \"sys_\" are typically system parameters that are automatically generated and cannot be updated.",
    },
    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",
      ],
    },
    x_no_response_body: {
      type: "boolean",
      description: "By default, responses include body content detailing the modified record. Set this request header to true to suppress the response body.",
      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_fields: {
      type: "string",
      description: "A comma-separated list of fields to return in the response.",
      optional: true,
    },
    sysparm_input_display_value: {
      type: "boolean",
      description: "Flag that indicates whether to set field values using the display value or the actual value.\n* `true`: Treats input values as display values and they are manipulated so they can be stored properly in the database.\n* `false`: Treats input values as actual values and stored them in the database without manipulation.",
      optional: true,
    },
    sysparm_view: {
      type: "string",
      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
      optional: true,
      options: [
        "desktop",
        "mobile",
        "both",
      ],
    },
    sysparm_query_no_domain: {
      type: "boolean",
      description: "True to access data across domains if authorized (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#c_TableAPI
    Section Table - PATCH /now/table/{tableName}/{sys_id}                      */

    if (!this.table_name || !this.sys_id || !this.update_fields) {
      throw new Error("Must provide table_name, sys_id, and update_fields parameters.");
    }

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

    return await axios($, {
      method: "patch",
      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}/${this.sys_id}`,
      headers: {
        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
        "Accept": this.request_format || "application/json",
        "Content-Type": this.response_format || "application/json",
        "X-no-response-body": this.x_no_response_body,
      },
      params: {
        sysparm_display_value: this.sysparm_display_value,
        sysparm_fields: this.sysparm_fields,
        sysparm_input_display_value: this.sysparm_input_display_value,
        sysparm_view: this.sysparm_view,
        sysparm_query_no_domain: this.sysparm_query_no_domain,
      },
      data: this.update_fields,
    });
  },
};

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 record to update.
sys_id	`sys_id`	`string`	Unique identifier of the record to update.
update_fields	`update_fields`	`object`	An object with name-value pairs with the fields to update in the specified record. Note: All fields within a record may not be available for update. For example, fields that have a prefix of "sys_" are typically system parameters that are automatically generated and cannot be updated.
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`
x_no_response_body	`x_no_response_body`	`boolean`	By default, responses include body content detailing the modified record. Set this request header to true to suppress the response body.
sysparm_display_value	`sysparm_display_value`	`string`	Select a value from the drop down menu:`truefalseall`
sysparm_fields	`sysparm_fields`	`string`	A comma-separated list of fields to return in the response.
sysparm_input_display_value	`sysparm_input_display_value`	`boolean`	Flag that indicates whether to set field values using the display value or the actual value. `true`: Treats input values as display values and they are manipulated so they can be stored properly in the database. `false`: Treats input values as actual values and stored them in the database without manipulation.
sysparm_view	`sysparm_view`	`string`	Select a value from the drop down menu:`desktopmobileboth`
sysparm_query_no_domain	`sysparm_query_no_domain`	`boolean`	True to access data across domains if authorized (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:

About ServiceNow#

The smarter way to workflow

More Ways to Connect ServiceNow + Slack#

Other Popular Integrations#

Get Table Record By SysId with ServiceNow API on New Message In Channels from Slack API

Slack + ServiceNow

Update Table Record with ServiceNow API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for ServiceNow, Slack and 1200+ other apps remarkably fast.

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

Developers ♥ Pipedream

Should I use the Slack or Slack Bot app on Pipedream?

Getting Started

Accounts

Within a workflow

Troubleshooting

Getting Started

ServiceNow Authorization Reference

1-12of1200+apps by most popular

1
-
12
of
1200+
apps by most popular