Create User with Clerk API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Clerk, Typeform and 2,000+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create User with the Clerk API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Typeform 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 Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create User action
1. Connect your Clerk account
2. Optional- Configure External Id
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Configure Email Addresses
6. Optional- Configure Phone Numbers
7. Optional- Configure Web3 Wallets
8. Optional- Configure Username
9. Configure Password
10. Optional- Configure Password Digest
11. Optional- Configure Password Hasher
12. Optional- Configure Skip Password Checks
13. Optional- Configure Skip Password Requirement
14. Optional- Configure TOTP Secret
15. Optional- Configure Backup Codes
16. Optional- Configure Public Metadata
17. Optional- Configure Private Metadata
18. Optional- Configure Unsafe Metadata
19. 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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform 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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Typeform uses OAuth authentication. When you connect your Typeform account, Pipedream will open a popup window where you can sign into Typeform and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Typeform API.

Pipedream requests the following authorization scopes when you connect your account:

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create User on Clerk

Description:Creates a new user. Your user management settings determine how you should setup your user model. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser)

Version:0.0.1

Key:clerk-create-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 {
  parseError, parseObject,
} from "../../common/utils.mjs";

export default {
  key: "clerk-create-user",
  name: "Create User",
  version: "0.0.1",
  description: "Creates a new user. Your user management settings determine how you should setup your user model. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser)",
  type: "action",
  props: {
    clerk,
    externalId: {
      propDefinition: [
        clerk,
        "externalId",
      ],
      optional: true,
    },
    firstName: {
      propDefinition: [
        clerk,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        clerk,
        "lastName",
      ],
      optional: true,
    },
    emailAddress: {
      type: "string[]",
      label: "Email Addresses",
      description: "Email addresses to add to the user. Must be unique across your instance. The first email address will be set as the user's primary email address.",
    },
    phoneNumber: {
      type: "string[]",
      label: "Phone Numbers",
      description: "Phone numbers to add to the user. Must be unique across your instance. The first phone number will be set as user's primary phone number.",
      optional: true,
    },
    web3Wallet: {
      type: "string[]",
      label: "Web3 Wallets",
      description: "Web3 wallets to add to the user. Must be unique across your instance. The first wallet will be set as the user's primary wallet.",
      optional: true,
    },
    username: {
      propDefinition: [
        clerk,
        "username",
      ],
      optional: true,
    },
    password: {
      propDefinition: [
        clerk,
        "password",
      ],
    },
    passwordDigest: {
      type: "string",
      label: "Password Digest",
      description: "In case you already have the password digests and not the passswords, you can use them for the newly created user via this property. The digests should be generated with one of the supported algorithms. The hashing algorithm can be specified using the `Password Hasher` property.",
      optional: true,
    },
    passwordHasher: {
      type: "string",
      label: "Password Hasher",
      description: "The hashing algorithm that was used to generate the password digest. The algorithms that Clerk supports at the moment are `bcrypt`, `bcrypt_sha256_django`, `md5`, `pbkdf2_sha256`, `pbkdf2_sha256_django`, `phpass`, `scrypt_firebase` and 2 `argon2` variants, `argon2i` and `argon2id`. Each of the above expects the incoming digest to be of a particular format. [See the documentarion](https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser!path=password_hasher&t=request) for further information.",
      optional: true,
    },
    skipPasswordChecks: {
      propDefinition: [
        clerk,
        "skipPasswordChecks",
      ],
      optional: true,
    },
    skipPasswordRequirement: {
      type: "boolean",
      label: "Skip Password Requirement",
      description: "When set to `true`, `password` is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. Please note that you cannot use this flag if password is the only way for a user to sign into your instance.",
      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,
    },
    createdAt: {
      propDefinition: [
        clerk,
        "createdAt",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.passwordDigest) {
      this.password = null;
    }
    try {
      const response = await this.clerk.createUser({
        $,
        data: {
          external_id: this.externalId,
          first_name: this.firstName,
          last_name: this.lastName,
          email_address: parseObject(this.emailAddress),
          phone_number: parseObject(this.phoneNumber),
          web3_wallet: parseObject(this.web3Wallet),
          username: this.username,
          password: this.password,
          password_digest: this.passwordDigest,
          password_hasher: this.passwordHasher,
          skip_password_checks: this.skipPasswordChecks,
          skip_password_requirement: this.skipPasswordRequirement,
          totp_secret: this.totpSecret,
          backup_codes: parseObject(this.backupCodes),
          public_metadata: parseObject(this.publicMetadata),
          private_metadata: parseObject(this.privateMetadata),
          unsafe_metadata: parseObject(this.unsafeMetadata),
          created_at: this.createdAt,
        },
      });

      $.export("$summary", `A new user with Id: ${response.id} was successfully created!`);
      return response;
    } catch (err) {
      return parseError(err);
    }
  },
};

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.
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.
Email Addresses	`emailAddress`	`string[]`	Email addresses to add to the user. Must be unique across your instance. The first email address will be set as the user's primary email address.
Phone Numbers	`phoneNumber`	`string[]`	Phone numbers to add to the user. Must be unique across your instance. The first phone number will be set as user's primary phone number.
Web3 Wallets	`web3Wallet`	`string[]`	Web3 wallets to add to the user. Must be unique across your instance. The first wallet will be set as the user's primary wallet.
Username	`username`	`string`	The username to give to the user. It must be unique across your instance.
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.
Password Digest	`passwordDigest`	`string`	In case you already have the password digests and not the passswords, you can use them for the newly created user via this property. The digests should be generated with one of the supported algorithms. The hashing algorithm can be specified using the `Password Hasher` property.
Password Hasher	`passwordHasher`	`string`	The hashing algorithm that was used to generate the password digest. The algorithms that Clerk supports at the moment are `bcrypt`, `bcrypt_sha256_django`, `md5`, `pbkdf2_sha256`, `pbkdf2_sha256_django`, `phpass`, `scrypt_firebase` and 2 `argon2` variants, `argon2i` and `argon2id`. Each of the above expects the incoming digest to be of a particular format. See the documentarion for further information.
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.
Skip Password Requirement	`skipPasswordRequirement`	`boolean`	When set to `true`, `password` is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. Please note that you cannot use this flag if password is the only way for a user to sign into your instance.
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.`
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`).