Get Record Counts by Field with ServiceNow API on New Event from Eversign API

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

Trigger workflow on

New Event from the Eversign API

Next, do this

Get Record Counts by Field 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 Eversign 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 Event trigger
1. Connect your Eversign account
2. Configure API Key
3. Select one or more Events
Configure the Get Record Counts by Field action
1. Connect your ServiceNow account
2. Select a Table
3. Configure Group By Field
4. Optional- Configure Count
5. Optional- Configure Query
6. Configure aggregateInfo
7. Optional- Configure Average Aggregate Fields
8. Optional- Configure Minimum Aggregate Fields
9. Optional- Configure Maximum Aggregate Fields
10. Optional- Configure Sum Aggregate Fields
11. Optional- Configure Having Query
12. Optional- Select a Response Data Format
13. Optional- Configure Order By
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 Event on Eversign

Description:Emit new event when a new event occurs in EverSign. To begin receiving events, navigate to your Developer dashboard, and enter the URL of this source/workflow as the Webhook URL. https://eversign.com/api/documentation/webhooks

Version:0.0.1

Key:eversign-new-event

View on GitHub

Eversign Overview#

The Eversign API enables you to automate document workflows by electronically signing, sending, and managing documents. With Eversign, you can create legally binding documents, send them out for signature, and track their status. This eliminates manual tasks, reduces errors, and speeds up the document handling process. Pipedream's integration with Eversign lets you trigger workflows based on document events, or perform actions like creating and sending documents automatically, thereby integrating seamless e-signature processes within your digital ecosystem.

Trigger Code#

import crypto from "crypto";
import app from "../../eversign.app.mjs";
import options from "../../options.mjs";

export default {
  key: "eversign-new-event",
  type: "source",
  name: "New Event",
  description: "Emit new event when a new event occurs in EverSign. To begin receiving events, navigate to your Developer dashboard, and enter the URL of this source/workflow as the Webhook URL. https://eversign.com/api/documentation/webhooks",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    app,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    apiKey: {
      type: "string",
      label: "API Key",
      description: "The API key for your account. You can find it in your developer settings.",
    },
    events: {
      type: "string[]",
      label: "Events",
      description: "The events you want to watch for",
      options: options.WEBHOOK_EVENTS,
    },
  },
  methods: {
    _getMeta({
      event_hash,
      event_type,
      event_time,
    }) {
      return {
        id: event_hash,
        summary: `${event_type} - ${event_hash}`,
        ts: event_time,
      };
    },
    _checkHmac(eventType, eventTime, receivedHash) {
      console.log("Checking HMAC...");

      if (!eventType || !eventTime || !receivedHash) {
        throw new Error("Missing required parameters");
      }

      const data = eventTime + eventType;
      const expectedSignature = crypto.createHmac("sha256", this.apiKey)
        .update(data, "utf8")
        .digest("hex");

      if (receivedHash !== expectedSignature) {
        throw new Error("Invalid HMAC Signature, connection aborted.");
      }

      console.log("HMAC check passed");
    },
  },
  async run(req) {
    console.log("Event received");
    if (!req.body) {
      throw new Error("Missing body");
    }

    if (this.events.indexOf(req.body.event_type) === -1) {
      console.log("Event not in list of watched events, skipping");
      return;
    }

    this._checkHmac(
      req.body.event_type,
      req.body.event_time,
      req.body.event_hash,
    );
    this.$emit(req.body, this._getMeta(req.body));
    this.http.respond({
      status: 200,
      headers: {
        "Content-Type": "application/json",
      },
    });
  },
};

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
Eversign	`app`	`app`	This component uses the Eversign app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
API Key	`apiKey`	`string`	The API key for your account. You can find it in your developer settings.
Events	`events`	`string[]`	Select a value from the drop down menu:`document_createddocument_vieweddocument_sentdocument_signeddocument_declineddocument_forwardedsigner_removedsigner_bounceddocument_completeddocument_expireddocument_revokeddocument_cancelledemail_validation_waived`

Trigger Authentication#

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

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

About Eversign#

Free, Legally Binding Online Signatures

Action#

Get Record Counts by Field on ServiceNow

Description:Retrieves the count of records grouped by a specified field from a ServiceNow table. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats)

Version:0.0.1

Key:servicenow-get-record-counts-by-field

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 { ConfigurationError } from "@pipedream/platform";
import servicenow from "../../servicenow.app.mjs";

export default {
  key: "servicenow-get-record-counts-by-field",
  name: "Get Record Counts by Field",
  description: "Retrieves the count of records grouped by a specified field from a ServiceNow table. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats)",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    servicenow,
    table: {
      propDefinition: [
        servicenow,
        "table",
      ],
    },
    groupByField: {
      type: "string",
      label: "Group By Field",
      description: "The field to group records by (e.g., `priority`, `state`, `category`)",
    },
    count: {
      type: "boolean",
      label: "Count",
      description: "If true, returns the number of records returned by the query",
      optional: true,
      default: true,
    },
    query: {
      label: "Query",
      type: "string",
      description: "An [encoded query string](https://www.servicenow.com/docs/bundle/zurich-platform-user-interface/page/use/using-lists/concept/c_EncodedQueryStrings.html) to filter records before aggregation (e.g., `active=true^priority=1`)",
      optional: true,
    },
    aggregateInfo: {
      type: "alert",
      alertType: "info",
      content: "You must provide at least one Aggregate Field. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats) for more information.",
    },
    avgFields: {
      type: "string[]",
      label: "Average Aggregate Fields",
      description: "Numeric fields to calculate averages for (e.g., `reassignment_count`, `reopen_count`)",
      optional: true,
    },
    minFields: {
      type: "string[]",
      label: "Minimum Aggregate Fields",
      description: "Numeric fields to find minimum values for",
      optional: true,
    },
    maxFields: {
      type: "string[]",
      label: "Maximum Aggregate Fields",
      description: "Numeric fields to find maximum values for",
      optional: true,
    },
    sumFields: {
      type: "string[]",
      label: "Sum Aggregate Fields",
      description: "Numeric fields to calculate sums for",
      optional: true,
    },
    havingQuery: {
      type: "string",
      label: "Having Query",
      description: "Filter the aggregated results (e.g., `COUNT>10` to only show groups with more than 10 records)",
      optional: true,
    },
    responseDataFormat: {
      propDefinition: [
        servicenow,
        "responseDataFormat",
      ],
    },
    orderBy: {
      type: "string",
      label: "Order By",
      description: "Field to sort results by. Prefix with `^ORDER_BY` for ascending or `^ORDER_BYDESC` for descending (e.g., `^ORDER_BYDESC` + field name)",
      optional: true,
    },
  },
  async run({ $ }) {
    const params = {
      sysparm_count: this.count,
      sysparm_query: this.query,
      sysparm_group_by: this.groupByField,
      sysparm_display_value: this.responseDataFormat,
      sysparm_having: this.havingQuery,
      sysparm_order_by: this.orderBy,
    };

    let hasAggregateFields = false;

    // Add aggregate functions for each field type
    if (this.avgFields?.length) {
      params.sysparm_avg_fields = this.avgFields.join?.() || this.avgFields;
      hasAggregateFields = true;
    }
    if (this.minFields?.length) {
      params.sysparm_min_fields = this.minFields.join?.() || this.minFields;
      hasAggregateFields = true;
    }
    if (this.maxFields?.length) {
      params.sysparm_max_fields = this.maxFields.join?.() || this.maxFields;
      hasAggregateFields = true;
    }
    if (this.sumFields?.length) {
      params.sysparm_sum_fields = this.sumFields.join?.() || this.sumFields;
      hasAggregateFields = true;
    }

    if (!hasAggregateFields) {
      throw new ConfigurationError("You must provide at least one Aggregate Field. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats) for more information.");
    }

    const response = await this.servicenow.getRecordCountsByField({
      $,
      table: this.table,
      params,
    });

    $.export("$summary", `Successfully retrieved ${response?.length || 0} records grouped by field "${this.groupByField}"`);

    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.
Group By Field	`groupByField`	`string`	The field to group records by (e.g., `priority`, `state`, `category`)
Count	`count`	`boolean`	If true, returns the number of records returned by the query
Query	`query`	`string`	An encoded query string to filter records before aggregation (e.g., `active=true^priority=1`)
Average Aggregate Fields	`avgFields`	`string[]`	Numeric fields to calculate averages for (e.g., `reassignment_count`, `reopen_count`)
Minimum Aggregate Fields	`minFields`	`string[]`	Numeric fields to find minimum values for
Maximum Aggregate Fields	`maxFields`	`string[]`	Numeric fields to find maximum values for
Sum Aggregate Fields	`sumFields`	`string[]`	Numeric fields to calculate sums for
Having Query	`havingQuery`	`string`	Filter the aggregated results (e.g., `COUNT>10` to only show groups with more than 10 records)
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" }`
Order By	`orderBy`	`string`	Field to sort results by. Prefix with `^ORDER_BY` for ascending or `^ORDER_BYDESC` for descending (e.g., `^ORDER_BYDESC` + field name)

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:

Try it

Get Table Record By SysId with ServiceNow API on New Event from Eversign API

Eversign + ServiceNow

Try it

Get Table Records with ServiceNow API on New Event from Eversign API

Eversign + ServiceNow

Try it

Update Table Record with ServiceNow API on New Event from Eversign API

Eversign + ServiceNow

Try it

Create Case with ServiceNow API on New Event from Eversign API

Eversign + ServiceNow

Try it

Popular Triggers#

New Event from the Eversign API

Emit new event when a new event occurs in EverSign. To begin receiving events, navigate to your Developer dashboard, and enter the URL of this source/workflow as the Webhook URL. https://eversign.com/api/documentation/webhooks

Try it