Create Case with ServiceNow API on New Sheet Created from Orca Scan API

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

Trigger workflow on

New Sheet Created from the Orca Scan API

Next, do this

Create Case 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 Orca Scan 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 Sheet Created trigger
1. Connect your Orca Scan account
2. Configure timer
Configure the Create Case action
1. Connect your ServiceNow account
2. Optional- Configure Name
3. Configure Description
4. Select a Severity
5. Optional- Configure Status
6. Optional- Configure Channel Name
7. Optional- Configure Account ID
8. Optional- Configure Contact 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#

New Sheet Created on Orca Scan

Description:Emit new event when a new sheet is created in Orca Scan. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3)

Version:0.0.1

Key:orca_scan-new-sheet

View on GitHub

Orca Scan Overview#

The Orca Scan API is a gateway to integrate barcode scanning and inventory management capabilities into various workflows. By leveraging the API, you can automate data collection, streamline inventory tracking, and sync your barcode scanning data with other systems. When used on Pipedream, you can merge Orca Scan functionalities with countless other apps, creating custom automation rules, processing data, and managing inventory in real-time. Ideal for inventory management, asset tracking, and data collection automation, the Orca Scan API is a tool that can adapt to a myriad of business needs.

Trigger Code#

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

export default {
  ...common,
  key: "orca_scan-new-sheet",
  name: "New Sheet Created",
  description: "Emit new event when a new sheet is created in Orca Scan. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    _getLastInfo() {
      return this.db.get("lastId") || 0;
    },
    _setLastInfo(row) {
      return this.db.set("lastId", row._id);
    },
    async getData(maxResults = false, lastId) {
      const { data: sheets } = await this.orcaScan.listSheets();

      let pos = -1;
      let sortedSheets = sheets;
      if (lastId) {
        pos = sheets.findIndex((sheet) => sheet._id == lastId);
        if (pos != -1) sortedSheets = sheets.slice(pos + 1);
      }

      if (maxResults && sortedSheets.length >= maxResults) sortedSheets.length = maxResults;
      return sortedSheets.reverse();
    },
    getEmit(sheet) {
      return {
        id: sheet._id,
        summary: `New Sheet: ${sheet.name}`,
        ts: Date.now(),
      };
    },
  },
  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
Orca Scan	`orcaScan`	`app`	This component uses the Orca Scan app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Orca Scan#

Build a barcode system without code.

Action#

Create Case on ServiceNow

Description:Creates a new case 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-case

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-case",
  name: "Create Case",
  description: "Creates a new case 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,
        "caseSeverity",
      ],
    },
    status: {
      propDefinition: [
        servicenow,
        "status",
      ],
    },
    channelName: {
      propDefinition: [
        servicenow,
        "channelName",
      ],
    },
    accountId: {
      propDefinition: [
        servicenow,
        "accountId",
      ],
    },
    contactId: {
      propDefinition: [
        servicenow,
        "contactId",
      ],
    },
    workNote: {
      propDefinition: [
        servicenow,
        "workNote",
      ],
    },
    comment: {
      propDefinition: [
        servicenow,
        "comment",
      ],
    },
  },
  async run({ $ }) {
    const {
      name,
      description,
      severity,
      status,
      channelName,
      accountId,
      contactId,
      workNote,
      comment,
    } = this;

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

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

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

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

    $.export("$summary", "Successfully created a case.");

    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" }`
Status	`status`	`string`	The current status of the ticket.
Channel Name	`channelName`	`string`	The channel (`contact_type`) that the ticket was created through.
Account ID	`accountId`	`string`	`Sys_id` of the account related to the case.
Contact ID	`contactId`	`string`	`Sys_id` of the contact related to the case.
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: