Create Note with Vitally API on Updated Document (Instant) from signNow API

Pipedream makes it easy to connect APIs for Vitally, signNow and 2,700+ other apps remarkably fast.

Trigger workflow on

Updated Document (Instant) from the signNow API

Next, do this

Create Note with the Vitally 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 signNow trigger and Vitally action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Updated Document (Instant) trigger
1. Connect your signNow account
Configure the Create Note action
1. Connect your Vitally account
2. Select a Account Id
3. Select a Organization Id
4. Configure Note
5. Configure Note Date
6. Optional- Configure External Id
7. Optional- Configure Subject
8. Optional- Select a Assigned To Id
9. Optional- Select a Category Id
10. Optional- Configure Tags
11. Optional- Configure Traits
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#

Updated Document (Instant) on signNow

Description:Emit new event when a document has been updated. [See the documentation](https://docs.signnow.com/docs/signnow/webhooks/operations/create-a-api-v-2-event)

Version:0.0.1

Key:signnow-updated-document-instant

View on GitHub

Trigger Code#

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

export default {
  ...common,
  key: "signnow-updated-document-instant",
  name: "Updated Document (Instant)",
  description: "Emit new event when a document has been updated. [See the documentation](https://docs.signnow.com/docs/signnow/webhooks/operations/create-a-api-v-2-event)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getEntityId() {
      const { id } = await this.app.getUserInfo();
      return id;
    },
    getEventName() {
      return events.USER_DOCUMENT_UPDATE;
    },
    generateMeta(resource) {
      const {
        document_id: documentId,
        document_name: documentName,
      } = resource.content;
      const { timestamp: ts } = resource.meta;
      return {
        id: `${documentId}-${ts}`,
        summary: `Updated Document: ${documentName}`,
        ts,
      };
    },
  },
  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
signNow	`app`	`app`	This component uses the signNow app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.

Trigger Authentication#

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

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

About signNow#

Electronic signature that scales with your workflow. Create and scale eSignature workflows with signNow, part of the airSlate Business Cloud. Sign and send documents for signing, generate agreements, negotiate contracts, accept payments, and automate business processes.

Action#

Create Note on Vitally

Description:Create a new note. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/notes#create-a-note-post)

Version:0.0.2

Key:vitally-create-note

View on GitHub

Vitally Overview#

The Vitally API offers a window into customer success operations, enabling you to automate workflows, integrate with other tools, and manipulate customer data programmatically. With Pipedream, you can harness this API to create custom automations that react to events in Vitally, sync data between Vitally and other platforms, or maintain up-to-date customer profiles across your business stack.

Action Code#

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

export default {
  key: "vitally-create-note",
  name: "Create Note",
  version: "0.0.2",
  description: "Create a new note. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/notes#create-a-note-post)",
  type: "action",
  props: {
    vitally,
    accountId: {
      propDefinition: [
        vitally,
        "accountId",
      ],
      description: "The ID of the Vitally Account to associate the Note with. Not to be confused with an External ID, this is the Vitally Account ID.",
    },
    organizationId: {
      propDefinition: [
        vitally,
        "organizationId",
      ],
    },
    note: {
      type: "string",
      label: "Note",
      description: "The body of the note, may include HTML.",
    },
    noteDate: {
      type: "string",
      label: "Note Date",
      description: "The timestamp of when the Note was created. `Format: YYYY-MM-DDTHH:MM:mm:ss.SSSZ`.",
    },
    externalId: {
      propDefinition: [
        vitally,
        "externalId",
      ],
      description: "The unique ID of the Note in your system.",
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject or title of the Note.",
      optional: true,
    },
    authorId: {
      propDefinition: [
        vitally,
        "assignedToId",
        ({ accountId }) => ({
          accountId,
        }),
      ],
      description: "The ID of the Vitally User who created the Note.",
      optional: true,
    },
    categoryId: {
      propDefinition: [
        vitally,
        "noteCategoryId",
      ],
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "An array of string tags to associate to the note.",
      optional: true,
    },
    traits: {
      type: "object",
      label: "Traits",
      description: "A key-value JSON object of custom note traits.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      vitally,
      ...data
    } = this;

    const response = await vitally.createNote({
      $,
      data,
    });

    $.export("$summary", `A new note with Id: ${response.id} was successfully created!`);
    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
Vitally	`vitally`	`app`	This component uses the Vitally app.
Account Id	`accountId`	`string`	Select a value from the drop down menu.
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.
Note	`note`	`string`	The body of the note, may include HTML.
Note Date	`noteDate`	`string`	The timestamp of when the Note was created. `Format: YYYY-MM-DDTHH:MM:mm:ss.SSSZ`.
External Id	`externalId`	`string`	The unique ID of the Note in your system.
Subject	`subject`	`string`	The subject or title of the Note.
Assigned To Id	`authorId`	`string`	Select a value from the drop down menu.
Category Id	`categoryId`	`string`	Select a value from the drop down menu.
Tags	`tags`	`string[]`	An array of string tags to associate to the note.
Traits	`traits`	`object`	A key-value JSON object of custom note traits.

Action Authentication#

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

To retrieve your API Key,