Create Document with GetAccept API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for GetAccept, Pipedream and 2,400+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

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

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Document action
1. Connect your GetAccept account
2. Configure Name
3. Optional- Select a Type
4. Optional- Configure Value
5. Optional- Configure File Ids
6. Optional- Configure File Name
7. Optional- Configure File URL
8. Optional- Configure Recipients
9. Optional- Configure Is Signing
10. Optional- Configure Is Signing Order
11. Optional- Configure Is Signing Biometric
12. Optional- Configure Is Signing Initials
13. Optional- Configure Is Self-sign
14. Optional- Configure Expiration Date
15. Optional- Configure Is Reminder Sending
16. Optional- Configure Is Signing Forward
17. Optional- Configure Is Identify Recipient
18. Optional- Configure Is SMS Sending
19. Optional- Configure Is Automatic Sending
20. Optional- Configure Is Scheduled Sending
21. Optional- Configure Scheduled Sending Time
22. Optional- Configure Video Id
23. Optional- Configure Template Id
24. Optional- Configure Replace Pages
25. Optional- Configure Keep Fields
26. Optional- Select a Sender Email
27. Optional- Configure Communication Template Id
28. Optional- Configure Email Send Subject
29. Optional- Configure Email Send Message
30. Optional- Configure Custom Fields
31. Optional- Configure Attachments
32. Optional- Configure Custom Pricing Tables
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Create Document on GetAccept

Description:Create a document to be able to send it to a recipient. [See the documentation](https://app.getaccept.com/api/#createdocument)

Version:0.0.1

Key:getaccept-create-document

View on GitHub

GetAccept Overview#

The GetAccept API offers a suite of capabilities for automating and enhancing document workflow and e-signature processes. Within Pipedream's serverless environment, you can leverage the GetAccept API to create documents, send them for e-signature, track their status, and manage recipients. By integrating GetAccept with other apps on Pipedream, you can build powerful workflows to streamline how your business handles agreements, sales proposals, and contracts.

Action Code#

import { parseArray } from "../../common/utils.mjs";
import getaccept from "../../getaccept.app.mjs";

export default {
  key: "getaccept-create-document",
  name: "Create Document",
  version: "0.0.1",
  description: "Create a document to be able to send it to a recipient. [See the documentation](https://app.getaccept.com/api/#createdocument)",
  type: "action",
  props: {
    getaccept,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the document.",
    },
    type: {
      type: "string",
      label: "Type",
      description: "Document type is used to set default values and look of a document.",
      options: [
        "sales",
        "hr",
        "introduction",
        "other",
      ],
      optional: true,
    },
    value: {
      type: "string",
      label: "Value",
      description: "Monetary value of document in entity currency.",
      optional: true,
    },
    fileIds: {
      type: "string[]",
      label: "File Ids",
      description: "File Ids to previusly uploaded files, see section [\"Upload document(s)\" here](https://app.getaccept.com/api/#uploadfile).",
      optional: true,
    },
    fileName: {
      type: "string",
      label: "File Name",
      description: "Sending a file, you must to type the filename of the document, with the extension. This will be helpful for converting different file-types.",
      optional: true,
    },
    fileURL: {
      type: "string",
      label: "File URL",
      description: "Url to document file. Documents must be public available for download.",
      optional: true,
    },
    recipients: {
      type: "string[]",
      label: "Recipients",
      description: "A list of valid JSON of recipients you're sending the document to. Every object must contain first_name, last_name (or fullname) and email fields. The 'role' field is optional. If not set, a person will be assigned the role signer. [See the object here](https://app.getaccept.com/api/#createdocument).",
      optional: true,
    },
    isSigning: {
      type: "boolean",
      label: "Is Signing",
      description: "Should the document be enabled for e-signing.",
      optional: true,
    },
    isSigningOrder: {
      type: "boolean",
      label: "Is Signing Order",
      description: "Use specific order for signers.",
      optional: true,
    },
    isSigningBiometric: {
      type: "boolean",
      label: "Is Signing Biometric",
      description: "Drawn signature when signing.",
      optional: true,
    },
    isSigningInitials: {
      type: "boolean",
      label: "Is Signing Initials",
      description: "Initials are set as default sign method.",
      optional: true,
    },
    isSelfsign: {
      type: "boolean",
      label: "Is Self-sign",
      description: "Should the sender also sign the document.",
      optional: true,
    },
    expirationDate: {
      type: "string",
      label: "Expiration Date",
      description: "Default value from entity settings but can be overrided by setting a date. Accepted formats: `yyyy-MM-dd`, `dd-MM-yyyy`, `MM/dd/yyyy`, `yyyy-MM-ddTHH:mm:ss.SSSZ`, `Unix timestamp in seconds`",
      optional: true,
    },
    isReminderSending: {
      type: "boolean",
      label: "Is Reminder Sending",
      description: "Should the system automatically send reminders based on the entity sending settings?",
      optional: true,
    },
    isSigningForward: {
      type: "boolean",
      label: "Is Signing Forward",
      description: "Should a recipient be able to forward the signing rights to someone else?",
      optional: true,
    },
    isIdentifyRecipient: {
      type: "boolean",
      label: "Is Identify Recipient",
      description: "Enable identification of new recipients by cookie.",
      optional: true,
    },
    isSMSSending: {
      type: "boolean",
      label: "Is SMS Sending",
      description: "Should the sending automatically include an SMS message to recipients with valid mobile numbers?",
      optional: true,
    },
    isAutomaticSending: {
      type: "boolean",
      label: "Is Automatic Sending",
      description: "Used to send documents immediately. Requires a file-parameter to import and send. **true: Send immediately** and **false: Status draft**.",
      optional: true,
    },
    isScheduledSending: {
      type: "boolean",
      label: "Is Scheduled Sending",
      description: "If the automatic sending should be scheduled.",
      optional: true,
    },
    scheduledSendingTime: {
      type: "string",
      label: "Scheduled Sending Time",
      description: "Date and time when document will be sent if scheduled.",
      optional: true,
    },
    videoId: {
      type: "string",
      label: "Video Id",
      description: "Specify a video to be presented before the document is opened.",
      optional: true,
    },
    templateId: {
      type: "string",
      label: "Template Id",
      description: "Use this to specify a template to be used for the document.",
      optional: true,
    },
    replacePages: {
      type: "boolean",
      label: "Replace Pages",
      description: "True to replace pages in template.",
      optional: true,
    },
    keepFields: {
      type: "boolean",
      label: "Keep Fields",
      description: "True to keep form fields in template.",
      optional: true,
    },
    senderEmail: {
      propDefinition: [
        getaccept,
        "senderEmail",
      ],
      optional: true,
    },
    communicationTemplateId: {
      type: "string",
      label: "Communication Template Id",
      description: "Use this to specify the communication template to be used for the document.",
      optional: true,
    },
    emailSendSubject: {
      type: "string",
      label: "Email Send Subject",
      description: "Use this to specify the subject line used to send out the document.",
      optional: true,
    },
    emailSendMessage: {
      type: "string",
      label: "Email Send Message",
      description: "Use this to specify a message to the recipient(s) when sending out the document.",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Enter custom data to be used identifying the field either by **name** or **id**.",
      optional: true,
    },
    attachments: {
      type: "string[]",
      label: "Attachments",
      description: "A list of attachments to include with the document. Every attachment must contain a type and a title. If the type is file, it must have the **Id** field, if the type is external, it must have **url** field. [See the object here](https://app.getaccept.com/api/#createdocument).",
      optional: true,
    },
    customPricingTables: {
      type: "string[]",
      label: "Custom Pricing Tables",
      description: "A list of pricing-table objects. [See the object here](https://app.getaccept.com/api/#createdocument).",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      getaccept,
      fileIds,
      fileName,
      fileURL,
      recipients,
      isSigning,
      isSigningOrder,
      isSigningBiometric,
      isSigningInitials,
      isSelfsign,
      expirationDate,
      isReminderSending,
      isSigningForward,
      isIdentifyRecipient,
      isSMSSending,
      isAutomaticSending,
      isScheduledSending,
      scheduledSendingTime,
      videoId,
      templateId,
      replacePages,
      keepFields,
      senderEmail,
      communicationTemplateId,
      emailSendSubject,
      emailSendMessage,
      customFields,
      attachments,
      customPricingTables,
      ...data
    } = this;

    const response = await getaccept.createDocument({
      $,
      data: {
        file_ids: fileIds,
        file_name: fileName,
        file_url: fileURL,
        recipients: recipients && parseArray(recipients),
        is_signing: isSigning,
        is_signing_order: isSigningOrder,
        is_signing_biometric: isSigningBiometric,
        is_signing_initials: isSigningInitials,
        is_selfsign: isSelfsign,
        expiration_date: expirationDate,
        is_reminder_sending: isReminderSending,
        is_signing_forward: isSigningForward,
        is_identify_recipient: isIdentifyRecipient,
        is_sms_sending: isSMSSending,
        is_automatic_sending: isAutomaticSending,
        is_scheduled_sending: isScheduledSending,
        scheduled_sending_time: scheduledSendingTime,
        video_id: videoId,
        template_id: templateId,
        replace_pages: replacePages,
        keep_fields: keepFields,
        sender_email: senderEmail,
        communication_template_id: communicationTemplateId,
        email_send_subject: emailSendSubject,
        email_send_message: emailSendMessage,
        custom_fields: customFields?.length && Object.entries(customFields).map(([
          key,
          value,
        ]) => ({
          id: key,
          value,
        })),
        attachments: attachments && parseArray(attachments),
        custom_pricing_tables: customPricingTables && parseArray(customPricingTables),
        ...data,
      },
    });

    $.export("$summary", `A new document 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
GetAccept	`getaccept`	`app`	This component uses the GetAccept app.
Name	`name`	`string`	The name of the document.
Type	`type`	`string`	Select a value from the drop down menu:`saleshrintroductionother`
Value	`value`	`string`	Monetary value of document in entity currency.
File Ids	`fileIds`	`string[]`	File Ids to previusly uploaded files, see section "Upload document(s)" here.
File Name	`fileName`	`string`	Sending a file, you must to type the filename of the document, with the extension. This will be helpful for converting different file-types.
File URL	`fileURL`	`string`	Url to document file. Documents must be public available for download.
Recipients	`recipients`	`string[]`	A list of valid JSON of recipients you're sending the document to. Every object must contain first_name, last_name (or fullname) and email fields. The 'role' field is optional. If not set, a person will be assigned the role signer. See the object here.
Is Signing	`isSigning`	`boolean`	Should the document be enabled for e-signing.
Is Signing Order	`isSigningOrder`	`boolean`	Use specific order for signers.
Is Signing Biometric	`isSigningBiometric`	`boolean`	Drawn signature when signing.
Is Signing Initials	`isSigningInitials`	`boolean`	Initials are set as default sign method.
Is Self-sign	`isSelfsign`	`boolean`	Should the sender also sign the document.
Expiration Date	`expirationDate`	`string`	Default value from entity settings but can be overrided by setting a date. Accepted formats: `yyyy-MM-dd`, `dd-MM-yyyy`, `MM/dd/yyyy`, `yyyy-MM-ddTHH:mm:ss.SSSZ`, `Unix timestamp in seconds`
Is Reminder Sending	`isReminderSending`	`boolean`	Should the system automatically send reminders based on the entity sending settings?
Is Signing Forward	`isSigningForward`	`boolean`	Should a recipient be able to forward the signing rights to someone else?
Is Identify Recipient	`isIdentifyRecipient`	`boolean`	Enable identification of new recipients by cookie.
Is SMS Sending	`isSMSSending`	`boolean`	Should the sending automatically include an SMS message to recipients with valid mobile numbers?
Is Automatic Sending	`isAutomaticSending`	`boolean`	Used to send documents immediately. Requires a file-parameter to import and send. true: Send immediately and false: Status draft.
Is Scheduled Sending	`isScheduledSending`	`boolean`	If the automatic sending should be scheduled.
Scheduled Sending Time	`scheduledSendingTime`	`string`	Date and time when document will be sent if scheduled.
Video Id	`videoId`	`string`	Specify a video to be presented before the document is opened.
Template Id	`templateId`	`string`	Use this to specify a template to be used for the document.
Replace Pages	`replacePages`	`boolean`	True to replace pages in template.
Keep Fields	`keepFields`	`boolean`	True to keep form fields in template.
Sender Email	`senderEmail`	`string`	Select a value from the drop down menu.
Communication Template Id	`communicationTemplateId`	`string`	Use this to specify the communication template to be used for the document.
Email Send Subject	`emailSendSubject`	`string`	Use this to specify the subject line used to send out the document.
Email Send Message	`emailSendMessage`	`string`	Use this to specify a message to the recipient(s) when sending out the document.
Custom Fields	`customFields`	`object`	Enter custom data to be used identifying the field either by name or id.
Attachments	`attachments`	`string[]`	A list of attachments to include with the document. Every attachment must contain a type and a title. If the type is file, it must have the Id field, if the type is external, it must have url field. See the object here.
Custom Pricing Tables	`customPricingTables`	`string[]`	A list of pricing-table objects. See the object here.

Action Authentication#

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

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

basic

About GetAccept#

Our digital sales room empowers revenue teams to increase win rates by engaging and understanding buyers from opportunity to signed deal.

More Ways to Connect GetAccept + Pipedream#

Other Popular Integrations#

Create Contact with GetAccept API on New Scheduled Tasks from Pipedream API

Pipedream + GetAccept

Create Document with GetAccept API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for GetAccept, Pipedream and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular