Create or Update User with Userflow API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform 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 Typeform 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 Submission trigger
1. Connect your Typeform account
2. Select a Form
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 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 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.