Upload Document for Parsing with Affinda API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

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

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
Configure the Upload Document for Parsing action
1. Connect your Affinda account
2. Select a Organization
3. Select a Workspace
4. Select a Collection
5. Configure URL
6. Optional- Configure Wait
7. Optional- Configure Identifier
8. Optional- Configure File Name
9. Optional- Configure Expiry Time
10. Optional- Configure Language
11. Optional- Configure Reject Duplicates
12. Optional- Configure Region Bias
13. Optional- Configure Low Priority
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.5

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Upload Document for Parsing on Affinda

Description:Uploads a document for parsing. [See docs here](https://docs.affinda.com/reference/createdocument)

Version:0.0.1

Key:affinda-upload-document-from-url

View on GitHub

Affinda Overview#

The Affinda API offers a suite of powerful tools for document analysis and extraction, enabling you to automate the processing of resumes, invoices, bank statements, and other documents. By parsing detailed information from documents, Affinda can transform unstructured data into structured, actionable insights. With Pipedream, you can integrate Affinda's capabilities into serverless workflows, connecting to hundreds of apps to automate tasks like candidate screening, financial data aggregation, or content management.

Action Code#

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

export default {
  key: "affinda-upload-document-from-url",
  name: "Upload Document for Parsing",
  description: "Uploads a document for parsing. [See docs here](https://docs.affinda.com/reference/createdocument)",
  version: "0.0.1",
  type: "action",
  props: {
    affinda,
    organization: {
      propDefinition: [
        affinda,
        "organization",
      ],
    },
    workspace: {
      propDefinition: [
        affinda,
        "workspace",
        (c) => ({
          organization: c.organization,
        }),
      ],
    },
    collection: {
      propDefinition: [
        affinda,
        "collection",
        (c) => ({
          workspace: c.workspace,
        }),
      ],
    },
    url: {
      type: "string",
      label: "URL",
      description: "URL to download the document.",
    },
    wait: {
      type: "boolean",
      label: "Wait",
      description: "If `true`, will return a response only after processing has completed. If `false`, will return an empty data object which can be polled at the GET endpoint until processing is complete. Defaults to `true`.",
      optional: true,
    },
    identifier: {
      type: "string",
      label: "Identifier",
      description: "Specify a custom identifier for the document.",
      optional: true,
    },
    fileName: {
      type: "string",
      label: "File Name",
      description: "Optional filename of the file",
      optional: true,
    },
    expiryTime: {
      type: "string",
      label: "Expiry Time",
      description: "The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.",
      optional: true,
    },
    rejectDuplicates: {
      type: "boolean",
      label: "Reject Duplicates",
      description: "If `true`, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If `false`, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.",
      optional: true,
    },
    regionBias: {
      type: "object",
      label: "Region Bias",
      description: "A JSON representation of the RegionBias object. Example: `{\"country\": \"vn\"}`",
      optional: true,
    },
    lowPriority: {
      type: "boolean",
      label: "Low Priority",
      description: "Explicitly mark this document as low priority.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (typeof this.regionBias === "string") {
      this.regionBias = JSON.parse(this.regionBias);
    }

    const response = await this.affinda.uploadDocument({
      $,
      data: {
        url: this.url,
        collection: this.collection,
        workspace: this.workspace,
        wait: this.wait,
        identifier: this.identifier,
        fileName: this.fileName,
        expiryTime: this.expiryTime,
        language: this.language,
        rejectDuplicates: this.rejectDuplicates,
        regionBias: this.regionBias,
        lowPriority: this.lowPriority,
      },
    });
    $.export("$summary", "Document uploaded successfully");
    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
Affinda	`affinda`	`app`	This component uses the Affinda app.
Organization	`organization`	`string`	Select a value from the drop down menu.
Workspace	`workspace`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
URL	`url`	`string`	URL to download the document.
Wait	`wait`	`boolean`	If `true`, will return a response only after processing has completed. If `false`, will return an empty data object which can be polled at the GET endpoint until processing is complete. Defaults to `true`.
Identifier	`identifier`	`string`	Specify a custom identifier for the document.
File Name	`fileName`	`string`	Optional filename of the file
Expiry Time	`expiryTime`	`string`	The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
Language	`language`	`string`	Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
Reject Duplicates	`rejectDuplicates`	`boolean`	If `true`, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If `false`, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
Region Bias	`regionBias`	`object`	A JSON representation of the RegionBias object. Example: `{"country": "vn"}`
Low Priority	`lowPriority`	`boolean`	Explicitly mark this document as low priority.