Create or Update User with Userflow API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

Create or Update User with the Userflow 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 Userflow 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 Create or Update User action
1. Connect your Userflow account
2. Select a User ID
3. Optional- Configure Number Of Groups
4. Optional- Configure Number Of Memberships
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#

Create or Update User on Userflow

Description:Creates or updates a user in Userflow. If the user does not already exist in Userflow, it will be created. If it already exists, the given attributes will be merged into the existing user's attributes. [See the documentation](https://docs.userflow.com/api/users/create-or-update)

Version:0.0.1

Key:userflow-create-update-user

View on GitHub

Userflow Overview#

The Userflow API allows you to automate and integrate the process of creating and managing in-app guides and walkthroughs. Using the API within Pipedream, you can programmatically trigger events, update user attributes, and manage flows, thereby creating a personalized user experience within your application. This opens up possibilities for syncing user data, customizing user onboarding experiences, and tracking user progress without manual intervention.

Action Code#

import app from "../../userflow.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "userflow-create-update-user",
  name: "Create or Update User",
  description: "Creates or updates a user in Userflow. If the user does not already exist in Userflow, it will be created. If it already exists, the given attributes will be merged into the existing user's attributes. [See the documentation](https://docs.userflow.com/api/users/create-or-update)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
    },
    numberOfGroups: {
      type: "integer",
      label: "Number Of Groups",
      description: "The number of groups to create/update for the user.",
      reloadProps: true,
      optional: true,
    },
    numberOfMemberships: {
      type: "integer",
      label: "Number Of Memberships",
      description: "The number of memberships to create/update for the user.",
      reloadProps: true,
      optional: true,
    },
  },
  async additionalProps() {
    const {
      app,
      numberOfGroups = 0,
      numberOfMemberships = 0,
    } = this;
    let groups = [];

    const { data: userAttributes } = await app.listAttributeDefinitions({
      params: {
        scope: constants.SCOPE.USER,
        limit: 10,
      },
    });

    const { data: groupAttributes } = await app.listAttributeDefinitions({
      params: {
        scope: constants.SCOPE.GROUP,
        limit: 10,
      },
    });

    const { data: membershipAttributes } = await app.listAttributeDefinitions({
      params: {
        scope: constants.SCOPE.GROUP_MEMBERSHIP,
        limit: 10,
      },
    });

    if (numberOfGroups || numberOfMemberships) {
      ({ data: groups } = await app.listGroups({
        params: {
          limit: 100,
        },
      }));
    }

    const userAttributesProps = userAttributes.reduce((props, {
      name, display_name: label, data_type: dataType, description,
    }) => ({
      ...props,
      [`${constants.KEYATTR.USER}${name}`]: {
        type: constants.DATA_TYPE_TO_PROP_TYPE[dataType] || "string",
        label,
        description: description || label,
        optional: true,
      },
    }), {});

    const groupAttributesProps =
      Array.from({
        length: numberOfGroups || 0,
      }).reduce((props, _, index) => ({
        ...props,
        [`${constants.KEYATTR.GROUP}${index + 1}${constants.SEP}id`]: {
          type: "string",
          label: `Group ${index + 1} - ID`,
          description: "The unique identifier for the group.",
          optional: true,
          options: groups.map(({
            id: value, attributes: { name: label },
          }) => ({
            value,
            label: label || value,
          })),
        },
        ...Object.fromEntries(
          Object.entries(groupAttributes)
            .map(([
              ,
              {
                name,
                display_name: label,
                data_type: dataType,
                description,
              },
            ]) => [
              `${constants.KEYATTR.GROUP}${index + 1}${constants.SEP}${name}`,
              {
                type: constants.DATA_TYPE_TO_PROP_TYPE[dataType] || "string",
                label: `Group ${index + 1} - ${label}`,
                description: description || label,
                optional: true,
              },
            ]),
        ),
      }), {});

    const membershipAttributesProps =
      Array.from({
        length: numberOfMemberships || 0,
      }).reduce((props, _, index) => ({
        ...props,
        ...Object.fromEntries(
          Object.entries(membershipAttributes)
            .map(([
              ,
              {
                name,
                display_name: label,
                data_type: dataType,
                description,
              },
            ]) => [
              `${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}${name}`,
              {
                type: constants.DATA_TYPE_TO_PROP_TYPE[dataType] || "string",
                label: `Membership ${index + 1} - ${label}`,
                description: description || label,
                optional: true,
              },
            ]),
        ),
        [`${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}groupId`]: {
          type: "string",
          label: `Membership ${index + 1} - Group ID`,
          description: "The unique identifier for the group.",
          optional: true,
          options: groups.map(({
            id: value, attributes: { name: label },
          }) => ({
            value,
            label: label || value,
          })),
        },
        [`${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}groupAttributes`]: {
          type: "object",
          label: `Membership ${index + 1} - Group Attributes`,
          description: "A map of group attributes to set for the group.",
          optional: true,
        },
      }), {});

    return {
      ...userAttributesProps,
      ...groupAttributesProps,
      ...membershipAttributesProps,
    };
  },
  methods: {
    createUpdateUser(args = {}) {
      return this.app.post({
        path: "/users",
        ...args,
      });
    },
    getUserAttributes(data) {
      if (!data) {
        return;
      }
      return Object.fromEntries(
        Object.entries(data)
          .filter(([
            key,
          ]) => key.startsWith(constants.KEYATTR.USER))
          .map(([
            key,
            value,
          ]) => [
            key.replace(constants.KEYATTR.USER, ""),
            value,
          ]),
      );
    },
    getGroupAttributes(data, length = 0) {
      if (!data) {
        return;
      }
      const groups = Array.from({
        length,
      }).reduce((acc, _, index) => {
        const searchString = `${constants.KEYATTR.GROUP}${index + 1}${constants.SEP}`;
        const id = data[`${searchString}id`];
        const attributes = Object.fromEntries(
          Object.entries(data)
            .filter(([
              key,
            ]) => key.startsWith(searchString) && key !== `${searchString}id`)
            .map(([
              key,
              value,
            ]) => [
              key.replace(searchString, ""),
              value,
            ]),
        );
        const group = {
          id,
          attributes,
        };
        return [
          ...acc,
          group,
        ];
      }, []);

      if (!groups?.length) {
        return;
      }

      return groups;
    },
    getMembershipAttributes(data, length = 0) {
      if (!data) {
        return;
      }
      const memberships = Array.from({
        length,
      }).reduce((acc, _, index) => {
        const searchString = `${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}`;
        const groupId = data[`${searchString}groupId`];
        const groupAttributes = data[`${searchString}groupAttributes`];
        const attributes = Object.fromEntries(
          Object.entries(data)
            .filter(([
              key,
            ]) => key.startsWith(searchString) && key !== `${searchString}groupId` && key !== `${searchString}groupAttributes`)
            .map(([
              key,
              value,
            ]) => [
              key.replace(searchString, ""),
              value,
            ]),
        );
        const membership = {
          attributes,
          group: {
            id: groupId,
            attributes: groupAttributes,
          },
        };
        return [
          ...acc,
          membership,
        ];
      }, []);

      if (!memberships?.length) {
        return;
      }

      return memberships;
    },
  },
  async run({ $ }) {
    const {
      getUserAttributes,
      getGroupAttributes,
      getMembershipAttributes,
      numberOfGroups,
      numberOfMemberships,
      createUpdateUser,
      userId,
      ...data
    } = this;

    const response = await createUpdateUser({
      $,
      data: {
        id: userId,
        attributes: getUserAttributes(data),
        groups: getGroupAttributes(data, numberOfGroups),
        memberships: getMembershipAttributes(data, numberOfMemberships),
      },
    });

    $.export("$summary", `Successfully created or updated user 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
Userflow	`app`	`app`	This component uses the Userflow app.
User ID	`userId`	`string`	Select a value from the drop down menu.
Number Of Groups	`numberOfGroups`	`integer`	The number of groups to create/update for the user.
Number Of Memberships	`numberOfMemberships`	`integer`	The number of memberships to create/update for the user.

Action Authentication#

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

About Userflow#

User onboarding software. Build product tours, checklists and more. No coding needed.

More Ways to Connect Userflow + Twilio SendGrid#

Other Popular Integrations#

Create or Update User with Userflow API on New Contact from Twilio SendGrid API

Twilio SendGrid + Userflow

Create or Update User with Userflow API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Userflow, Twilio SendGrid 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