← Userflow

Create or Update User with Userflow API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create or Update User with the Userflow API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create or Update User with the Userflow API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create or Update User with Userflow API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Userflow
 
Try it
Create or Update User with Userflow API on New Submission from Typeform API
Typeform + Userflow
 
Try it
Create or Update User with Userflow API on Custom Events from Zoom API
Zoom + Userflow
 
Try it
Create or Update User with Userflow API on New Submission (Instant) from Jotform API
Jotform + Userflow
 
Try it
Create or Update User with Userflow API on New Scheduled Tasks from Pipedream API
Pipedream + Userflow
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
LabelPropTypeDescription
UserflowappappThis component uses the Userflow app.
User IDuserIdstringSelect a value from the drop down menu.
Number Of GroupsnumberOfGroupsinteger

The number of groups to create/update for the user.

Number Of MembershipsnumberOfMembershipsinteger

The number of memberships to create/update for the user.

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 Use Userflow

Triggers

New Checklist Completed (Instant) from the Userflow API

Emit new event when a user has completed all tasks in a checklist. See the documentation

 
Try it
New Event Tracked (Instant) from the Userflow API

Emit new new event when an event is tracked in Userflow. See the documentation

 
Try it
New Flow Completed (Instant) from the Userflow API

Emit new event when a flow is completed by a user by reaching a goal step. See the documentation

 
Try it

Actions

Find User with the Userflow API

Finds an existing user by user ID or email, optionally filtering by group ID. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Snowflake
Snowflake
A data warehouse built for the cloud
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
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.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.