Create Incident with ServiceNow API on Order Status Updated from BaseLinker API

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

Trigger workflow on

Order Status Updated from the BaseLinker API

Next, do this

Create Incident 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 BaseLinker 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 Order Status Updated trigger
1. Connect your BaseLinker account
2. Configure Polling schedule
Configure the Create Incident action
1. Connect your ServiceNow account
2. Optional- Configure Name
3. Configure Description
4. Select a Severity
5. Optional- Configure Status
6. Optional- Configure Contact Method
7. Optional- Configure Company ID
8. Optional- Configure User ID
9. Optional- Configure Work Note
10. Optional- Configure Comment
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#

Order Status Updated on BaseLinker

Description:Emit new event when an order status changes in BaseLinker. [See the Documentation](https://api.baselinker.com/index.php?method=getOrderStatusList).

Version:0.0.1

Key:baselinker-order-status-updated

View on GitHub

BaseLinker Overview#

The BaseLinker API offers access to a suite of e-commerce management tools, enabling seamless integration of orders, products, and inventory across various online sales channels. With Pipedream's ability to connect APIs, you can automate tasks between BaseLinker and other apps to streamline your e-commerce operations, from syncing inventory to processing orders.

Trigger Code#

import common from "../common/polling.mjs";
import events from "../common/events.mjs";

export default {
  ...common,
  key: "baselinker-order-status-updated",
  name: "Order Status Updated",
  description: "Emit new event when an order status changes in BaseLinker. [See the Documentation](https://api.baselinker.com/index.php?method=getOrderStatusList).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceName() {
      return "logs";
    },
    getResourceFn() {
      return this.app.listJournal;
    },
    getResourceFnArgs() {
      return {
        data: {
          parameters: {
            last_log_id: this.getLastLogId(),
            logs_types: [
              events.ORDER_STATUS_CHANGE,
            ],
          },
        },
      };
    },
    generateMeta(resource) {
      const ts = Date.now();
      return {
        id: `${resource.order_id}-${ts}`,
        summary: `Status Changed: ${resource.order_id}`,
        ts,
      };
    },
    async getResourceByEvent(event) {
      const { orders } = await this.app.listOrders({
        data: {
          parameters: {
            order_id: event.order_id,
            get_unconfirmed_orders: true,
          },
        },
      });
      return orders[0];
    },
  },
};

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
BaseLinker	`app`	`app`	This component uses the BaseLinker app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API

Trigger Authentication#

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

To retrieve your API key,

Navigate to your BaseLinker account and sign in
Go to “My Account” > “API”

About BaseLinker#

Integrate your e-commerce workflow in one place.

Action#

Create Incident on ServiceNow

Description:Creates a new incident record in ServiceNow. [See the docs here](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/trouble-ticket-open-api.html#title_trouble-ticket-POST-ticket-tt).

Version:0.0.1

Key:servicenow-create-incident

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";

export default {
  key: "servicenow-create-incident",
  name: "Create Incident",
  description: "Creates a new incident record in ServiceNow. [See the docs here](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/trouble-ticket-open-api.html#title_trouble-ticket-POST-ticket-tt).",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    servicenow,
    name: {
      propDefinition: [
        servicenow,
        "name",
      ],
    },
    description: {
      propDefinition: [
        servicenow,
        "description",
      ],
    },
    severity: {
      propDefinition: [
        servicenow,
        "incidentSeverity",
      ],
    },
    status: {
      propDefinition: [
        servicenow,
        "status",
      ],
    },
    contactMethod: {
      propDefinition: [
        servicenow,
        "contactMethod",
      ],
    },
    companyId: {
      propDefinition: [
        servicenow,
        "companyId",
      ],
    },
    userId: {
      propDefinition: [
        servicenow,
        "userId",
      ],
    },
    workNote: {
      propDefinition: [
        servicenow,
        "workNote",
      ],
    },
    comment: {
      propDefinition: [
        servicenow,
        "comment",
      ],
    },
  },
  async run({ $ }) {
    const {
      name,
      description,
      severity,
      status,
      contactMethod,
      companyId,
      userId,
      workNote,
      comment,
    } = this;

    const channel = this.servicenow.buildChannel(contactMethod);

    const relatedParties = this.servicenow.buildRelatedParties({
      customer: companyId,
      customer_contact: userId,
    });

    const notes = this.servicenow.buildNotes({
      workNote,
      comment,
    });

    const response = await this.servicenow.createTroubleTicket({
      $,
      data: {
        ticketType: "Incident",
        name,
        description,
        severity,
        status,
        channel,
        notes,
        relatedParties,
      },
    });

    $.export("$summary", "Successfully created an incident.");

    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.
Name	`name`	`string`	A short description of the ticket issue.
Description	`description`	`string`	A detailed description of the issue.
Severity	`severity`	`string`	Select a value from the drop down menu:`{ "label": "Critical", "value": "1" }{ "label": "High", "value": "2" }{ "label": "Moderate", "value": "3" }{ "label": "Low", "value": "4" }{ "label": "Planning", "value": "5" }`
Status	`status`	`string`	The current status of the ticket.
Contact Method	`contactMethod`	`string`	Name of the contact method (`contact_type`) that the ticket was created through.
Company ID	`companyId`	`string`	`Sys_id` of the company related to the incident.
User ID	`userId`	`string`	`Sys_id` of the user related to the incident.
Work Note	`workNote`	`string`	Internal work note for the ticket.
Comment	`comment`	`string`	Additional comment for the ticket.

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: