Create Text Annotation Task with Scale AI API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

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

Select this integration
Configure the New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Create Text Annotation Task action
1. Connect your Scale AI account
2. Optional- Select a Project
3. Optional- Configure Batch
4. Optional- Configure Instruction
5. Optional- Configure Callback URL
6. Optional- Configure Title
7. Optional- Configure Description
8. Optional- Configure Responses Required
9. Optional- Configure Priority
10. Optional- Configure Unique ID
11. Optional- Configure Clear Unique ID on Error
12. Configure Number of Fields
13. Configure Number of Attachments
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.7

Key:sendgrid-new-contact

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 orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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.
	`timer`	`$.interface.timer`

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#

Create Text Annotation Task on Scale AI

Description:Create a text annotation task. [See the documentation](https://docs.scale.com/reference/text-collection)

Version:0.0.2

Key:scale_ai-create-text-annotation-task

View on GitHub

Scale AI Overview#

Scale AI offers an API to automate and streamline data labeling for machine learning applications, providing access to a global workforce and sophisticated tools. With Scale AI's API on Pipedream, you can integrate scalable data annotation workflows directly into your apps. Trigger tasks, manage datasets, and receive annotated data, all within Pipedream's serverless platform. This enables seamless automation of labeling tasks, integration with machine learning pipelines, and real-time updates on annotations.

Action Code#

import app from "../../scale_ai.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "scale_ai-create-text-annotation-task",
  name: "Create Text Annotation Task",
  description: "Create a text annotation task. [See the documentation](https://docs.scale.com/reference/text-collection)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    project: {
      propDefinition: [
        app,
        "project",
      ],
    },
    batch: {
      propDefinition: [
        app,
        "batch",
      ],
    },
    instruction: {
      propDefinition: [
        app,
        "instruction",
      ],
    },
    callbackUrl: {
      propDefinition: [
        app,
        "callbackUrl",
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the task to be shown to scalers.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the task to be shown to scalers.",
      optional: true,
    },
    responsesRequired: {
      type: "integer",
      label: "Responses Required",
      description: "The number of responses required for the task to build consensus before returning the callback response. Upper bound of 100.",
      optional: true,
    },
    priority: {
      propDefinition: [
        app,
        "priority",
      ],
    },
    uniqueId: {
      propDefinition: [
        app,
        "uniqueId",
      ],
    },
    clearUniqueIdOnError: {
      type: "boolean",
      label: "Clear Unique ID on Error",
      description: "If set to be true, if a task errors out after being submitted, the **Unique ID** on the task will be unset. This param allows workflows where you can re-submit the same **Unique ID** to recover from errors automatically.",
      optional: true,
    },
    numberOfFields: {
      type: "integer",
      label: "Number of Fields",
      description: "The number of fields to be labeled",
      default: 1,
      reloadProps: true,
    },
    numberOfAttachments: {
      type: "integer",
      label: "Number of Attachments",
      description: "The number of attachments to be labeled",
      default: 1,
      reloadProps: true,
    },
  },
  methods: {
    choiceFieldsPropsMapper(prefix) {
      const {
        [`${prefix}label`]: label,
        [`${prefix}value`]: value,
        [`${prefix}hint`]: hint,
      } = this;

      return {
        label,
        value,
        hint,
      };
    },
    getChoiceFieldPropDefinitions({
      prefix, label,
    } = {}) {
      return {
        [`${prefix}label`]: {
          type: "string",
          label: `${label} - Label`,
          description: "The label of the choice.",
        },
        [`${prefix}value`]: {
          type: "string",
          label: `${label} - Value`,
          description: "The value of the choice.",
        },
        [`${prefix}hint`]: {
          type: "string",
          label: `${label} - Hint`,
          description: "The hint of the choice.",
          optional: true,
        },
      };
    },
    fieldsPropsMapper(prefix) {
      const {
        [`${prefix}type`]: type,
        [`${prefix}fieldId`]: fieldId,
        [`${prefix}title`]: title,
        [`${prefix}numberOfChoices`]: numberOfChoices,
        choiceFieldsPropsMapper,
      } = this;

      return {
        type,
        field_id: fieldId,
        title,
        choices: utils.getFieldsProps({
          numberOfFields: numberOfChoices,
          fieldName: "choice",
          prefix,
          propsMapper: choiceFieldsPropsMapper,
        }),
      };
    },
    getFieldsPropDefinitions({
      prefix,
      label,
    } = {}) {
      const {
        [`${prefix}numberOfChoices`]: numberOfChoices,
        getChoiceFieldPropDefinitions,
      } = this;

      return {
        [`${prefix}type`]: {
          type: "string",
          label: `${label} - Type`,
          description: "The type of field to be labeled.",
          optional: true,
          options: Object.values(constants.FIELD_CHOICE_TYPE),
        },
        [`${prefix}fieldId`]: {
          type: "string",
          label: `${label} - Field ID`,
          description: "A unique identifier for the field.",
          optional: true,
        },
        [`${prefix}title`]: {
          type: "string",
          label: `${label} - Title`,
          description: "The title of the field.",
          optional: true,
        },
        [`${prefix}numberOfChoices`]: {
          type: "integer",
          label: `${label} - Number of Choices`,
          description: "The number of choices for the field.",
          optional: true,
          default: 1,
          reloadProps: true,
        },
        ...utils.getAdditionalProps({
          numberOfFields: numberOfChoices,
          fieldName: "choice",
          prefix,
          label,
          getPropDefinitions: getChoiceFieldPropDefinitions,
        }),
      };
    },
    attachmentsPropsMapper(prefix) {
      const {
        [`${prefix}type`]: type,
        [`${prefix}content`]: content,
      } = this;

      return {
        type,
        content,
      };
    },
    getAttachmentsPropDefinitions({
      prefix,
      label,
    } = {}) {
      return {
        [`${prefix}type`]: {
          type: "string",
          label: `${label} - Type`,
          description: "The type of attachment. See [TextCollectionAttachment](https://docs.scale.com/reference/textcollectionattachment). One of `pdf`, `image`, `text`, `video`, `website`, or `audio`.",
          optional: true,
          options: Object.values(constants.ATTACHMENT_TYPE),
        },
        [`${prefix}content`]: {
          type: "string",
          label: `${label} - Content`,
          description: "The content of the attachment. See [TextCollectionAttachment](https://docs.scale.com/reference/textcollectionattachment).",
          optional: true,
        },
      };
    },
    createTextAnnotationTask(args = {}) {
      return this.app.post({
        path: "/task/textcollection",
        ...args,
      });
    },
  },
  async additionalProps() {
    const {
      numberOfFields,
      numberOfAttachments,
      getFieldsPropDefinitions,
      getAttachmentsPropDefinitions,
    } = this;

    const fields =  utils.getAdditionalProps({
      numberOfFields,
      fieldName: "field",
      getPropDefinitions: getFieldsPropDefinitions,
    });

    const attachments =  utils.getAdditionalProps({
      numberOfFields: numberOfAttachments,
      fieldName: "attachment",
      getPropDefinitions: getAttachmentsPropDefinitions,
    });

    return {
      ...fields,
      ...attachments,
    };
  },
  async run({ $: step }) {
    const {
      createTextAnnotationTask,
      project,
      batch,
      instruction,
      callbackUrl,
      title,
      description,
      responsesRequired,
      priority,
      uniqueId,
      clearUniqueIdOnError,
      numberOfFields,
      fieldsPropsMapper,
      numberOfAttachments,
      attachmentsPropsMapper,
    } = this;

    const response = await createTextAnnotationTask({
      step,
      data: {
        project,
        batch,
        instruction,
        callback_url: callbackUrl,
        title,
        description,
        responses_required: responsesRequired,
        priority,
        unique_id: uniqueId,
        clear_unique_id_on_error: clearUniqueIdOnError,
        fields: utils.getFieldsProps({
          numberOfFields,
          fieldName: "field",
          propsMapper: fieldsPropsMapper,
        }),
        attachments: utils.getFieldsProps({
          numberOfFields: numberOfAttachments,
          fieldName: "attachment",
          propsMapper: attachmentsPropsMapper,
        }),
      },
    });

    step.export("$summary", `Successfully created text annotation task with ID \`${response.task_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
Scale AI	`app`	`app`	This component uses the Scale AI app.
Project	`project`	`string`	Select a value from the drop down menu.
Batch	`batch`	`string`	The name of the batch to associate this task with. Note that if a batch is specified, you need not specify the project, as the task will automatically be associated with the batch's project. For Scale Rapid projects specifying a batch is required. See Batches section for more details.
Instruction	`instruction`	`string`	A markdown-enabled string or iframe embedded Google Doc explaining how to do the task. You can use markdown to show example images, give structure to your instructions, and more. See our instruction best practices for more details. For Scale Rapid projects, DO NOT set this field unless you specifically want to override the project level instructions.
Callback URL	`callbackUrl`	`string`	The full url (including the scheme `http://` or `https://`) or email address of the callback that will be used when the task is completed.
Title	`title`	`string`	The title of the task to be shown to scalers.
Description	`description`	`string`	The description of the task to be shown to scalers.
Responses Required	`responsesRequired`	`integer`	The number of responses required for the task to build consensus before returning the callback response. Upper bound of 100.
Priority	`priority`	`integer`	A value of 10, 20, or 30 that defines the priority of a task within a project. The higher the number, the higher the priority.
Unique ID	`uniqueId`	`string`	A arbitrary ID that you can assign to a task and then query for later. This ID must be unique across all projects under your account, otherwise the task submission will be rejected. See Avoiding Duplicate Tasks for more details.
Clear Unique ID on Error	`clearUniqueIdOnError`	`boolean`	If set to be true, if a task errors out after being submitted, the Unique ID on the task will be unset. This param allows workflows where you can re-submit the same Unique ID to recover from errors automatically.
Number of Fields	`numberOfFields`	`integer`	The number of fields to be labeled
Number of Attachments	`numberOfAttachments`	`integer`	The number of attachments to be labeled