Update Table Record with ServiceNow API on New Recording from Screendesk API

Pipedream makes it easy to connect APIs for ServiceNow, Screendesk and 3,000+ other apps remarkably fast.

Trigger workflow on

New Recording from the Screendesk API

Next, do this

Update Table Record with the ServiceNow API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Screendesk 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 Recording trigger
1. Connect your Screendesk account
2. Configure Polling interval
Configure the Update Table Record action
1. Connect your ServiceNow account
2. Select a Table
3. Configure Record ID
4. Configure Update Fields
5. Optional- Configure Replace Record
6. Optional- Select a Response Data Format
7. Optional- Configure Response Fields
8. Optional- Configure Input Display Value
9. Optional- Select a Response View
10. Optional- Configure Query Across Domains
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 Recording on Screendesk

Description:Emit new event when a new recording is created is sent or received.

Version:0.0.1

Key:screendesk-new-recording

View on GitHub

Screendesk Overview#

The Screendesk API lets you automate customer support tasks directly within your apps or websites. Imagine streamlining interactions like ticket creation, response tracking, and support analytics. With Pipedream, you can easily craft workflows that interact with the Screendesk API to enhance customer support efficiency, trigger actions based on ticket status, or synchronize support data with other tools.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import screendesk from "../../screendesk.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "screendesk-new-recording",
  name: "New Recording",
  version: "0.0.1",
  description: "Emit new event when a new recording is created is sent or received.",
  type: "source",
  dedupe: "unique",
  props: {
    screendesk,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Screendesk on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastId() {
      return this.db.get("lastId") || 0;
    },
    _setLastId(lastId) {
      this.db.set("lastId", lastId);
    },
    async startEvent(maxResults = 0) {
      const { screendesk } = this;

      const lastId = this._getLastId();
      const items = screendesk.paginate({
        fn: screendesk.listRecordings,
        maxResults,
      });

      let responseArray = [];

      for await (const item of items) {
        if (item.id <= lastId) break;
        responseArray.push(item);
      }
      if (responseArray.length) this._setLastId(responseArray[0].id);

      for (const item of responseArray.reverse()) {
        this.$emit(
          item,
          {
            id: item.id,
            summary: `A new recording with id: "${item.id}" was ${item.recording_type.toLowerCase()}!`,
            ts: new Date(),
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  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
Screendesk	`screendesk`	`app`	This component uses the Screendesk app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Screendesk on this schedule

Trigger Authentication#

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

About Screendesk#

Making customer support teams more productive.

Action#

Update Table Record on ServiceNow

Description:Updates the specified record with the name-value pairs included in the request body. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html#title_table-PATCH)

Version:1.0.0

Key:servicenow-update-table-record

View on GitHub

ServiceNow Overview#

The ServiceNow API lets developers access and manipulate records, manage workflows, and integrate with other services on its IT service management platform. These capabilities support automating tasks, syncing data across platforms, and boosting operational efficiencies.

Action Code#

import servicenow from "../../servicenow.app.mjs";
import { parseObject } from "../../common/utils.mjs";

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. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html#title_table-PATCH)",
  version: "1.0.0",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    servicenow,
    table: {
      propDefinition: [
        servicenow,
        "table",
      ],
    },
    recordId: {
      propDefinition: [
        servicenow,
        "recordId",
      ],
    },
    updateFields: {
      label: "Update Fields",
      type: "object",
      description: "The fields to update in the record, as key-value pairs (e.g. `{ \"name\": \"Jane Doe\", \"status\": \"active\" }`). **Note:** System fields (prefixed with `sys_`) are typically auto-generated and cannot be updated.",
    },
    replaceRecord: {
      type: "boolean",
      label: "Replace Record",
      description: "If true, replaces the entire record with the provided fields (uses PUT instead of PATCH). Any fields not provided will be cleared.",
      optional: true,
    },
    responseDataFormat: {
      propDefinition: [
        servicenow,
        "responseDataFormat",
      ],
    },
    responseFields: {
      propDefinition: [
        servicenow,
        "responseFields",
      ],
    },
    inputDisplayValue: {
      propDefinition: [
        servicenow,
        "inputDisplayValue",
      ],
    },
    responseView: {
      propDefinition: [
        servicenow,
        "responseView",
      ],
    },
    queryNoDomain: {
      propDefinition: [
        servicenow,
        "queryNoDomain",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.servicenow.updateTableRecord({
      $,
      table: this.table,
      recordId: this.recordId,
      replace: this.replaceRecord,
      data: parseObject(this.updateFields),
      params: {
        sysparm_display_value: this.responseDataFormat,
        sysparm_fields: this.responseFields?.join?.() || this.responseFields,
        sysparm_input_display_value: this.inputDisplayValue,
        sysparm_view: this.responseView,
        sysparm_query_no_domain: this.queryNoDomain,
      },
    });

    const action = this.replaceRecord
      ? "replaced"
      : "updated";
    $.export("$summary", `Successfully ${action} record ${this.recordId} in table "${this.table}"`);

    return response;
  },
};

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	`table`	`string`	Select a value from the drop down menu.
Record ID	`recordId`	`string`	The ID (`sys_id` field) of the record
Update Fields	`updateFields`	`object`	The fields to update in the record, as key-value pairs (e.g. `{ "name": "Jane Doe", "status": "active" }`). Note: System fields (prefixed with `sys_`) are typically auto-generated and cannot be updated.
Replace Record	`replaceRecord`	`boolean`	If true, replaces the entire record with the provided fields (uses PUT instead of PATCH). Any fields not provided will be cleared.
Response Data Format	`responseDataFormat`	`string`	Select a value from the drop down menu:`{ "value": "true", "label": "Returns the display values for all fields" }{ "value": "false", "label": "Returns the actual values from the database" }{ "value": "all", "label": "Returns both actual and display values" }`
Response Fields	`responseFields`	`string[]`	The fields to return in the response. By default, all fields are returned
Input Display Value	`inputDisplayValue`	`boolean`	If true, the input values are treated as display values (and are manipulated so they can be stored properly in the database)
Response View	`responseView`	`string`	Select a value from the drop down menu:`desktopmobileboth`
Query Across Domains	`queryNoDomain`	`boolean`	If true, allows access to data across domains (if authorized)

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: