Create Certified Email with Signaturit API on New Run State Changed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Signaturit, OpenAI (ChatGPT) and 2,400+ other apps remarkably fast.

Trigger workflow on

New Run State Changed from the OpenAI (ChatGPT) API

Next, do this

Create Certified Email with the Signaturit 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 OpenAI (ChatGPT) trigger and Signaturit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Run State Changed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Configure Thread ID
Configure the Create Certified Email action
1. Connect your Signaturit account
2. Optional- Configure Body
3. Optional- Select a Branding ID
4. Optional- Configure Events URL
5. Optional- Configure Custom Data
6. Optional- Configure Attachments
7. Configure Recipients
8. Optional- Select a Type
9. Optional- Configure Subject
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 Run State Changed on OpenAI (ChatGPT)

Description:Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)

Version:0.0.6

Key:openai-new-run-state-changed

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

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

export default {
  ...common,
  key: "openai-new-run-state-changed",
  name: "New Run State Changed",
  description: "Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    threadId: {
      propDefinition: [
        common.props.openai,
        "threadId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getStatusItems() {
      return this.db.get("statusItems");
    },
    setStatusItems(value) {
      this.db.set("statusItems", value);
    },
    async getData() {
      const {
        openai,
        threadId,
      } = this;

      const { data } = await openai.listRuns({
        threadId,
      });

      return data;
    },
    getMeta(item) {
      const ts = Date.now();
      return {
        id: `${item.id}-${ts}`,
        summary: `Run State Changed: ${item.id}`,
        ts,
      };
    },
    statusByItemId(itemId, statusItems) {
      const { [itemId]: status } = statusItems || {};
      return status;
    },
    buildStatusItems(data) {
      return data?.reduce((acc, item) => ({
        ...acc,
        [item.id]: item.status,
      }), {});
    },
    async getAndProcessItems(maxEvents) {
      const {
        getData,
        getStatusItems,
        setStatusItems,
        statusByItemId,
        buildStatusItems,
        getMeta,
        $emit: emit,
      } = this;

      const data = await getData();
      const statusItems = getStatusItems();

      Array.from(data)
        .reverse()
        .forEach((item, index) => {
          const statusChanged = statusByItemId(item.id, statusItems) !== item.status;
          if ((!maxEvents || index < maxEvents) && statusChanged) {
            emit(item, getMeta(item));
          }
        });

      setStatusItems(buildStatusItems(data));
    },
  },
  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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Thread ID	`threadId`	`string`	The unique identifier for the thread. Example: `thread_abc123`. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to "Visible to organization owners" or "Visible to everyone". You can then access the list of threads and click on individual threads to reveal their IDs

Trigger Authentication#

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

About OpenAI (ChatGPT)#

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Action#

Create Certified Email on Signaturit

Description:Initiates the creation of a certified email. [See the documentation](https://docs.signaturit.com/api/latest#emails_create_email)

Version:0.0.1

Key:signaturit-create-certified-email

View on GitHub

Signaturit Overview#

The Signaturit API enables automated document signing, tracking, and management directly within Pipedream. By integrating this API, users can create workflows to send documents for signature, check the status of sent documents, and receive updates when documents are signed or declined, all from a serverless platform. By leveraging Pipedream's capacity for integrating various APIs and services, users can seamlessly include e-signature capabilities into their business processes without manual intervention.

Action Code#

import FormData from "form-data";
import fs from "fs";
import { TYPE_OPTIONS } from "../../common/constants.mjs";
import {
  checkTmp,
  parseObject,
} from "../../common/utils.mjs";
import signaturit from "../../signaturit.app.mjs";

export default {
  key: "signaturit-create-certified-email",
  name: "Create Certified Email",
  description: "Initiates the creation of a certified email. [See the documentation](https://docs.signaturit.com/api/latest#emails_create_email)",
  version: "0.0.1",
  type: "action",
  props: {
    signaturit,
    body: {
      propDefinition: [
        signaturit,
        "body",
      ],
      optional: true,
    },
    brandingId: {
      propDefinition: [
        signaturit,
        "brandingId",
      ],
      optional: true,
    },
    eventsUrl: {
      propDefinition: [
        signaturit,
        "eventsUrl",
      ],
      optional: true,
    },
    data: {
      propDefinition: [
        signaturit,
        "data",
      ],
      optional: true,
    },
    attachments: {
      propDefinition: [
        signaturit,
        "attachments",
      ],
      optional: true,
    },
    recipients: {
      propDefinition: [
        signaturit,
        "recipients",
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "Type of certified email.",
      options: TYPE_OPTIONS,
      optional: true,
    },
    subject: {
      propDefinition: [
        signaturit,
        "subject",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const formData = new FormData();

    let i = 0;
    for (const recipient of parseObject(this.recipients)) {
      for (const [
        key,
        value,
      ] of Object.entries(recipient)) {
        formData.append(`recipients[${i}][${key}]`, value);
      }
      i++;
    }
    if (this.data) {
      for (const [
        key,
        value,
      ] of Object.entries(this.data)) {
        formData.append(`data[${key}]`, value);
      }
      i++;
    }
    if (this.body) formData.append("body", this.body);
    if (this.brandingId) formData.append("branding_id", this.brandingId);
    if (this.eventsUrl) formData.append("events_url", this.eventsUrl);
    if (this.type) formData.append("type", this.type);
    if (this.subject) formData.append("subject", this.subject);

    if (this.attachments) {
      let j = 0;
      for (const file of parseObject(this.attachments)) {
        formData.append(`attachments[${j++}]`, fs.createReadStream(checkTmp(file)));
      }
    }
    const response = await this.signaturit.createCertifiedEmail({
      $,
      data: formData,
      headers: formData.getHeaders(),
    });
    $.export("$summary", `Created certified email with ID: ${response.id}`);
    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
Signaturit	`signaturit`	`app`	This component uses the Signaturit app.
Body	`body`	`string`	Email body (html code is allowed).
Branding ID	`brandingId`	`string`	Select a value from the drop down menu.
Events URL	`eventsUrl`	`string`	URL to receive real-time events.
Custom Data	`data`	`object`	Custom key-value data in JSON format.
Attachments	`attachments`	`string[]`	A list of paths to the files saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). See the documentation.
Recipients	`recipients`	`string[]`	List of recipients in JSON format, e.g., '{"name": "John Doe", "email": "john@example.com"}'. See the documentation for further information.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Delivery - Send the email as it is certifying the delivery process.", "value": "delivery" }{ "label": "Open Document - Send a modified version of the email with a button that redirects the user to our platform to open the PDF attachments. With this method, you can track when the user opens the attached files. Note: This method only supports PDF documents to be attached.", "value": "open_document" }{ "label": "Open Every Document - This type works like the Open Document type but allows to track the opening of every PDF file in emails with multiple attachments.", "value": "open_every_document" }`
Subject	`subject`	`string`	Email subject for email type requests.

Action Authentication#

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

To retrieve your Acccess Token,

Navigate to your Signaturit account and sign in
Click the User dropdown on the top right
Go to “My account” > “Integrations”

Create Certified Email with Signaturit API on New Run State Changed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Signaturit, OpenAI (ChatGPT) 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