Update User with Clerk API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

Update User with the Clerk 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 Clerk 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 Update User action
1. Connect your Clerk account
2. Select a User Id
3. Optional- Configure External Id
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Select a Primary Email Address Id
7. Optional- Configure Notify Primary Email Address Changed
8. Optional- Select a Primary Phone Number Id
9. Optional- Select a Primary Web3 Wallet Id
10. Optional- Configure Username
11. Optional- Configure Profile Image Id
12. Optional- Configure Password
13. Optional- Configure Skip Password Checks
14. Optional- Configure Sign Out Of Other Sessions
15. Optional- Configure TOTP Secret
16. Optional- Configure Backup Codes
17. Optional- Configure Public Metadata
18. Optional- Configure Private Metadata
19. Optional- Configure Unsafe Metadata
20. Optional- Configure Delete Self Enable
21. Optional- Configure Create Organization Enabled
22. Optional- Configure Created At
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.6

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.6",
  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#

Update User on Clerk

Description:Update a user's attributes. You can set the user's primary contact identifiers (email address and phone numbers) by updating the `Primary Email Address Id` and `Primary Phone Number Id` attributes respectively. Both IDs should correspond to verified identifications that belong to the user. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser)

Version:0.0.1

Key:clerk-update-user

View on GitHub

Clerk Overview#

The Clerk API lets you manage user authentication and create secure, delightful user experiences in your apps. Within Pipedream's serverless platform, you can harness this API to automate workflows that trigger on user events, sync user data across apps, and maintain robust user management without the heavy lifting of building authentication infrastructure from scratch.

Action Code#

import clerk from "../../clerk.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "clerk-update-user",
  name: "Update User",
  version: "0.0.1",
  description: "Update a user's attributes. You can set the user's primary contact identifiers (email address and phone numbers) by updating the `Primary Email Address Id` and `Primary Phone Number Id` attributes respectively. Both IDs should correspond to verified identifications that belong to the user. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser)",
  type: "action",
  props: {
    clerk,
    userId: {
      propDefinition: [
        clerk,
        "userId",
      ],
    },
    externalId: {
      propDefinition: [
        clerk,
        "externalId",
      ],
      optional: true,
    },
    firstName: {
      propDefinition: [
        clerk,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        clerk,
        "lastName",
      ],
      optional: true,
    },
    primaryEmailAddressId: {
      propDefinition: [
        clerk,
        "primaryEmailAddressId",
        ({ userId }) => ({
          userId,
        }),
      ],
      optional: true,
    },
    notifyPrimaryEmailAddressChanged: {
      type: "boolean",
      label: "Notify Primary Email Address Changed",
      description: "If set to `true`, the user will be notified that their primary email address has changed. By default, no notification is sent.",
      optional: true,
    },
    primaryPhoneNumberId: {
      propDefinition: [
        clerk,
        "primaryPhoneNumberId",
        ({ userId }) => ({
          userId,
        }),
      ],
      optional: true,
    },
    primaryWeb3WalletId: {
      propDefinition: [
        clerk,
        "primaryWeb3WalletId",
        ({ userId }) => ({
          userId,
        }),
      ],
      optional: true,
    },
    username: {
      propDefinition: [
        clerk,
        "username",
      ],
      optional: true,
    },
    profileImageId: {
      type: "string",
      label: "Profile Image Id",
      description: "The ID of the image to set as the user's profile image",
      optional: true,
    },
    password: {
      propDefinition: [
        clerk,
        "password",
      ],
      optional: true,
    },
    skipPasswordChecks: {
      propDefinition: [
        clerk,
        "skipPasswordChecks",
      ],
      optional: true,
    },
    signOutOfOtherSessions: {
      type: "boolean",
      label: "Sign Out Of Other Sessions",
      description: "Set to `true` to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a `password`.",
      optional: true,
    },
    totpSecret: {
      propDefinition: [
        clerk,
        "totpSecret",
      ],
      optional: true,
    },
    backupCodes: {
      propDefinition: [
        clerk,
        "backupCodes",
      ],
      optional: true,
    },
    publicMetadata: {
      propDefinition: [
        clerk,
        "publicMetadata",
      ],
      optional: true,
    },
    privateMetadata: {
      propDefinition: [
        clerk,
        "privateMetadata",
      ],
      optional: true,
    },
    unsafeMetadata: {
      propDefinition: [
        clerk,
        "unsafeMetadata",
      ],
      optional: true,
    },
    deleteSelfEnable: {
      type: "boolean",
      label: "Delete Self Enable",
      description: "If `true`, the user can delete themselves with the Frontend API.",
      optional: true,
    },
    createOrganizationEnabled: {
      type: "boolean",
      label: "Create Organization Enabled",
      description: "If true, the user can create organizations with the Frontend API.",
      optional: true,
    },
    createdAt: {
      propDefinition: [
        clerk,
        "createdAt",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      clerk,
      userId,
    } = this;

    const response = await clerk.updateUser({
      $,
      userId,
      data: {
        external_id: this.externalId,
        first_name: this.firstName,
        last_name: this.lastName,
        primary_email_address_id: this.primaryEmailAddressId,
        notify_primary_email_address_changed: this.notifyPrimaryEmailAddressChanged,
        primary_phone_number_id: this.primaryPhoneNumberId,
        primary_web3_wallet_id: this.primaryWeb3WalletId,
        username: this.username,
        profile_image_id: this.profileImageId,
        password: this.password,
        skip_password_checks: this.skipPasswordChecks,
        sign_out_of_other_sessions: this.signOutOfOtherSessions,
        totp_secret: this.totpSecret,
        backup_codes: parseObject(this.backupCodes),
        public_metadata: parseObject(this.publicMetadata),
        private_metadata: parseObject(this.privateMetadata),
        unsafe_metadata: parseObject(this.unsafeMetadata),
        delete_self_enabled: this.deleteSelfEnable,
        create_organization_enabled: this.createOrganizationEnabled,
        created_at: this.createdAt,
      },
    });

    $.export("$summary", `The user with Id: ${userId} was successfully updated!`);
    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
Clerk	`clerk`	`app`	This component uses the Clerk app.
User Id	`userId`	`string`	Select a value from the drop down menu.
External Id	`externalId`	`string`	The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance.
First Name	`firstName`	`string`	The first name to assign to the user.
Last Name	`lastName`	`string`	The last name to assign to the user.
Primary Email Address Id	`primaryEmailAddressId`	`string`	Select a value from the drop down menu.
Notify Primary Email Address Changed	`notifyPrimaryEmailAddressChanged`	`boolean`	If set to `true`, the user will be notified that their primary email address has changed. By default, no notification is sent.
Primary Phone Number Id	`primaryPhoneNumberId`	`string`	Select a value from the drop down menu.
Primary Web3 Wallet Id	`primaryWeb3WalletId`	`string`	Select a value from the drop down menu.
Username	`username`	`string`	The username to give to the user. It must be unique across your instance.
Profile Image Id	`profileImageId`	`string`	The ID of the image to set as the user's profile image
Password	`password`	`string`	The plaintext password to give to the user. Must be at least 8 characters long, and can not be in any list of hacked passwords.
Skip Password Checks	`skipPasswordChecks`	`boolean`	When set to `true` all password checks are skipped. It is recommended to use this method only when migrating plaintext passwords to Clerk. Upon migration the user base should be prompted to pick stronger password.
Sign Out Of Other Sessions	`signOutOfOtherSessions`	`boolean`	Set to `true` to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a `password`.
TOTP Secret	`totpSecret`	`string`	In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Backup Codes	`backupCodes`	`string[]`	If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest.
Public Metadata	`publicMetadata`	`object`	Metadata saved on the user, that is visible to both your Frontend and Backend APIs.
Private Metadata	`privateMetadata`	`object`	Metadata saved on the user, that is only visible to your Backend API.
Unsafe Metadata	`unsafeMetadata`	`object`	Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. `Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.`
Delete Self Enable	`deleteSelfEnable`	`boolean`	If `true`, the user can delete themselves with the Frontend API.
Create Organization Enabled	`createOrganizationEnabled`	`boolean`	If true, the user can create organizations with the Frontend API.
Created At	`createdAt`	`string`	A custom date/time denoting when the user signed up to the application, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`).