Add or Update Contact with Twilio SendGrid API on New Avatar Video Completion from SpiritMe API

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

Trigger workflow on

New Avatar Video Completion from the SpiritMe API

Next, do this

Add or Update Contact with the Twilio SendGrid 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 SpiritMe trigger and Twilio SendGrid action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Avatar Video Completion trigger
1. Connect your SpiritMe account
2. Configure timer
Configure the Add or Update Contact action
1. Connect your Twilio SendGrid account
2. Optional- Select one or more List Ids
3. Select a Email
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Address Line 1
7. Optional- Configure Address Line 2
8. Optional- Configure Alternate Emails
9. Optional- Configure City
10. Optional- Configure Country
11. Optional- Configure Postal Code
12. Optional- Configure State Province Region
13. Optional- Configure Custom Fields
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 Avatar Video Completion on SpiritMe

Description:Emit new event when an avatar video completes rendering.

Version:0.0.1

Key:spiritme-new-avatar-video-completion

View on GitHub

Trigger Code#

import spiritme from "../../spiritme.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "spiritme-new-avatar-video-completion",
  name: "New Avatar Video Completion",
  description: "Emit new event when an avatar video completes rendering.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    spiritme,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    emitEvent(video) {
      const meta = this.generateMeta(video);
      this.$emit(video, meta);
    },
    generateMeta(video) {
      return {
        id: video.id,
        summary: `New Video: ${video.name}`,
        ts: Date.parse(video.gd),
      };
    },
    async processEvent(max) {
      const lastTs = this._getLastTs();
      const params = {
        limit: 100,
        offset: 0,
        status: [
          "success",
        ],
      };
      let total;

      const videos = [];
      do {
        const { results } = await this.spiritme.listVideos({
          params,
        });
        for (const video of results) {
          const ts = Date.parse(video.gd);
          if (ts >= lastTs && (!max || videos.length < max)) {
            videos.push(video);
          } else {
            break;
          }
        }
        params.offset += params.limit;
        total = results?.length;
      } while (total === params.limit && (!max || videos.length < max));

      if (!videos.length) {
        return;
      }

      this._setLastTs(Date.parse(videos[0].gd));
      videos.reverse().forEach((video) => this.emitEvent(video));
    },
  },
  async run() {
    await this.processEvent();
  },
  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
SpiritMe	`spiritme`	`app`	This component uses the SpiritMe app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About SpiritMe#

AI-video platform for creating personalized videos with digital avatars.

Action#

Add or Update Contact on Twilio SendGrid

Description:Adds or updates a contact. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/add-or-update-a-contact)

Version:0.0.4

Key:sendgrid-add-or-update-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.

Action Code#

import validate from "validate.js";
import common from "../common/common.mjs";

export default {
  ...common,
  key: "sendgrid-add-or-update-contact",
  name: "Add or Update Contact",
  description: "Adds or updates a contact. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/add-or-update-a-contact)",
  version: "0.0.4",
  type: "action",
  props: {
    ...common.props,
    listIds: {
      propDefinition: [
        common.props.sendgrid,
        "listIds",
      ],
    },
    email: {
      propDefinition: [
        common.props.sendgrid,
        "contactEmail",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The contact's personal name",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The contact's family name",
      optional: true,
    },
    addressLine1: {
      type: "string",
      label: "Address Line 1",
      description: "The first line of the address",
      optional: true,
    },
    addressLine2: {
      type: "string",
      label: "Address Line 2",
      description: "An optional second line for the address",
      optional: true,
    },
    alternateEmails: {
      type: "string[]",
      label: "Alternate Emails",
      description: "Additional emails associated with the contact",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The contact's city.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description:
        "The contact's country. Can be a full name or an abbreviation",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "The contact's ZIP code or other postal code",
      optional: true,
    },
    stateProvinceRegion: {
      type: "string",
      label: "State Province Region",
      description: "The contact's state, province, or region",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Custom fields for the contact",
      optional: true,
    },
  },
  async run({ $ }) {
    validate.validators.arrayValidator = this.validateArray;
    const constraints = {
      email: {
        presence: true,
        email: true,
      },
    };
    if (this.listIds) {
      constraints.listIds = {
        type: "array",
      };
    }
    if (this.alternateEmails) {
      constraints.cc = {
        type: "array",
      };
    }
    const validationResult = validate(
      {
        email: this.email,
        listIds: this.listIds,
        alternateEmails: this.alternateEmails,
      },
      constraints,
    );
    this.checkValidationResults(validationResult);
    const contacts = [
      {
        email: this.email,
        address_line_1: this.addressLine1,
        address_line_2: this.addressLine2,
        alternate_emails: this.alternateEmails,
        city: this.city,
        country: this.country,
        first_name: this.firstName,
        last_name: this.lastName,
        postal_code: this.postalCode,
        state_province_region: this.stateProvinceRegion,
        custom_fields: this.customFields,
      },
    ];
    const config = this.omitEmptyStringValues({
      list_ids: this.listIds,
      contacts,
    });
    const resp = await this.sendgrid.addOrUpdateContacts(config);
    $.export("$summary", "Successfully added/updated contact");
    return resp;
  },
};

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
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
List Ids	`listIds`	`string[]`	Select a value from the drop down menu.
Email	`email`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	The contact's personal name
Last Name	`lastName`	`string`	The contact's family name
Address Line 1	`addressLine1`	`string`	The first line of the address
Address Line 2	`addressLine2`	`string`	An optional second line for the address
Alternate Emails	`alternateEmails`	`string[]`	Additional emails associated with the contact
City	`city`	`string`	The contact's city.
Country	`country`	`string`	The contact's country. Can be a full name or an abbreviation
Postal Code	`postalCode`	`string`	The contact's ZIP code or other postal code
State Province Region	`stateProvinceRegion`	`string`	The contact's state, province, or region
Custom Fields	`customFields`	`object`	Custom fields for the contact