Create Table Record with ServiceNow API on New Record from Knack API

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

Trigger workflow on

New Record from the Knack API

Next, do this

Create Table Record with the ServiceNow API

No credit card required

▶

Watch us build a workflow

8 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 Knack 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 Record trigger
1. Connect your Knack account
2. Configure Object Key
3. Configure timer
Configure the Create Table Record action
1. Connect your ServiceNow account
2. Configure table_name
3. Configure table_record
4. Optional- Select a api_version
5. Optional- Select a request_format
6. Optional- Select a response_format
7. Optional- Configure x_no_response_body
8. Optional- Select a sysparm_display_value
9. Optional- Configure sysparm_exclude_reference_link
10. Optional- Configure sysparm_fields
11. Optional- Configure sysparm_input_display_value
12. Optional- Select a sysparm_view
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 Record on Knack

Description:Emit new event for each record created

Version:0.0.2

Key:knack-new-record

View on GitHub

Knack Overview#

The Knack API allows for robust interactions with your Knack database, enabling automation of data entry, retrieval, updates, and deletion. With Pipedream, you can leverage these capabilities to create seamless workflows that react to events in real-time, sync data across platforms, and enhance your database management without manual intervention. Think less about CRUD operations and more about the magic of connecting your Knack data to the digital tools ecosystem.

Trigger Code#

import knack from "../../knack.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "knack-new-record",
  name: "New Record",
  description: "Emit new event for each record created",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    knack,
    objectKey: {
      type: "string",
      label: "Object Key",
      description: "The key of the object which this record belongs to. See [the Knack API docs](https://docs.knack.com/docs/object-based-requests) for more information.",
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run({ $ }) {
    const records = await this.knack.getAllRecords($, {
      objectKey: this.objectKey,
    }, {
      rows_per_page: 100,
    }, true);

    for (const record of records) {
      this.$emit(record, {
        id: record.id,
        summary: `New record ${record.id}`,
        ts: new Date(),
      });
    }
  },
};

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
Knack	`knack`	`app`	This component uses the Knack app.
Object Key	`objectKey`	`string`	The key of the object which this record belongs to. See the Knack API docs for more information.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Object-based requests require at least two headers: an application ID - to identify to our servers the app whose records you are requesting - and an API key (which is specific to each app) to authenticate the request. See docs.

About Knack#

Business app platform

Action#

Create Table Record on ServiceNow

Description:Inserts one record in the specified table.

Version:0.1.1

Key:servicenow-create-table-record

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_k6irW7
import { axios } from "@pipedream/platform";

export default {
  key: "servicenow-create-table-record",
  name: "Create Table Record",
  description: "Inserts one record in the specified table.",
  version: "0.1.1",
  type: "action",
  props: {
    servicenow: {
      type: "app",
      app: "servicenow",
    },
    table_name: {
      type: "string",
      description: "The name of the table where the record will be created.",
    },
    table_record: {
      type: "object",
      description: "The table record object. Use name-value pairs for each field of the record.",
    },
    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",
      ],
    },
    response_format: {
      type: "string",
      description: "Format of REST response body.",
      optional: true,
      options: [
        "application/json",
        "application/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_exclude_reference_link: {
      type: "boolean",
      description: "Flag that indicates whether to exclude Table API links for reference fields.\n* `true`: Exclude Table API links for reference fields.\n* `false`: Include Table API links for reference fields.",
      optional: true,
    },
    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",
      ],
    },
  },
  async run({ $ }) {
  // See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#table-POST

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

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

    return await axios($, {
      method: "post",
      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",
        "X-no-response-body": this.x_no_response_body,
      },
      params: {
        sysparm_display_value: this.sysparm_display_value,
        sysparm_exclude_reference_link: this.sysparm_exclude_reference_link,
        sysparm_fields: this.sysparm_fields,
        sysparm_input_display_value: this.sysparm_input_display_value,
        sysparm_view: this.sysparm_view,
      },
      data: this.table_record,
    });
  },
};

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 where the record will be created.
table_record	`table_record`	`object`	The table record object. Use name-value pairs for each field of the record.
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/xml`
response_format	`response_format`	`string`	Select a value from the drop down menu:`application/jsonapplication/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_exclude_reference_link	`sysparm_exclude_reference_link`	`boolean`	Flag that indicates whether to exclude Table API links for reference fields. `true`: Exclude Table API links for reference fields. `false`: Include Table API links for reference fields.
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`

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: