Create Check with OnlineCheckWriter API on New Event from Eversign API

Pipedream makes it easy to connect APIs for OnlineCheckWriter, Eversign and 2,500+ other apps remarkably fast.

Trigger workflow on

New Event from the Eversign API

Next, do this

Create Check with the OnlineCheckWriter 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 OnlineCheckWriter 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 Create Check action
1. Connect your OnlineCheckWriter account
2. Select a Bank Account ID
3. Select a Payee ID
4. Optional- Select a Category ID
5. Optional- Configure Issue Date
6. Configure Amount
7. Optional- Configure Memo
8. Optional- Configure Note
9. Optional- Configure Invoice Number
10. Optional- Configure No Sign
11. Optional- Configure No Amount
12. Optional- Configure No Date
13. Optional- Configure No Payee
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#

Create Check on OnlineCheckWriter

Description:Creates a new check. [See the documentation](https://apiv3.onlinecheckwriter.com/#211cb6e4-bda7-46de-9e84-a5e8b2709206)

Version:0.0.1

Key:onlinecheckwriter-create-check

View on GitHub

Action Code#

import app from "../../onlinecheckwriter.app.mjs";

export default {
  key: "onlinecheckwriter-create-check",
  name: "Create Check",
  description: "Creates a new check. [See the documentation](https://apiv3.onlinecheckwriter.com/#211cb6e4-bda7-46de-9e84-a5e8b2709206)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    bankAccountId: {
      propDefinition: [
        app,
        "bankAccountId",
      ],
    },
    payeeId: {
      propDefinition: [
        app,
        "payeeId",
      ],
    },
    categoryId: {
      propDefinition: [
        app,
        "categoryId",
      ],
    },
    issueDate: {
      propDefinition: [
        app,
        "issueDate",
      ],
    },
    amount: {
      propDefinition: [
        app,
        "amount",
      ],
    },
    memo: {
      propDefinition: [
        app,
        "memo",
      ],
    },
    note: {
      propDefinition: [
        app,
        "note",
      ],
    },
    invoiceNumber: {
      propDefinition: [
        app,
        "invoiceNumber",
      ],
    },
    noSign: {
      propDefinition: [
        app,
        "noSign",
      ],
    },
    noAmount: {
      propDefinition: [
        app,
        "noAmount",
      ],
    },
    noDate: {
      propDefinition: [
        app,
        "noDate",
      ],
    },
    noPayee: {
      propDefinition: [
        app,
        "noPayee",
      ],
    },
  },
  methods: {
    createChecks(args = {}) {
      return this.app.post({
        path: "/checks",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createChecks,
      bankAccountId,
      payeeId,
      categoryId,
      issueDate,
      amount,
      memo,
      note,
      invoiceNumber,
      noSign,
      noAmount,
      noDate,
      noPayee,
    } = this;

    const response = await createChecks({
      $,
      data: {
        checks: [
          {
            bankAccountId,
            payeeId,
            categoryId,
            issueDate,
            amount,
            memo,
            note,
            invoiceNumber,
            noSign,
            noAmount,
            noDate,
            noPayee,
          },
        ],
      },
    });

    $.export("$summary", `Successfully created a new check with ID \`${response.data.checks[0].checkId}\`.`);
    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
OnlineCheckWriter	`app`	`app`	This component uses the OnlineCheckWriter app.
Bank Account ID	`bankAccountId`	`string`	Select a value from the drop down menu.
Payee ID	`payeeId`	`string`	Select a value from the drop down menu.
Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Issue Date	`issueDate`	`string`	By default it will be check creation date, If an Issue Date is passed, that will override any default. Eg. `2021-12-31`.
Amount	`amount`	`string`	The money value of the check.
Memo	`memo`	`string`	Max of 150 characters to be included on the memo line of the check.
Note	`note`	`string`	An internal note that identifies this check. Must be no longer than 150 characters.
Invoice Number	`invoiceNumber`	`string`	Any invoice number associated with this check
No Sign	`noSign`	`boolean`	if `true`, the check will be created without signature. Default `false`.
No Amount	`noAmount`	`boolean`	if `true`, the check will be created without amount. Default `false`
No Date	`noDate`	`boolean`	if `true`, the check will be created without date. Default `false`
No Payee	`noPayee`	`boolean`	if `true`, the check will be created without payee. Default `false`

Try it

Create Mail Check with OnlineCheckWriter API on New Event from Eversign API

Eversign + OnlineCheckWriter

Try it

Create Payee with OnlineCheckWriter API on New Event from Eversign API

Eversign + OnlineCheckWriter

Try it

Mail PDF Document with OnlineCheckWriter API on New Event from Eversign API

Eversign + OnlineCheckWriter

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