Skip to main content

​
Overview

We provide the Users API to allow you to create, manage, update, and disable individual user accounts. You will need to create a user in Embedded for each individual that intends on using the integrations Embedded powers. You can think of the User object like a container. The guide covers:
  • Creating Users
  • Deleting Users
  • Managing User Tokens
  • Accessing Workflow Logs

​
Creating Users

Each user on your platform that uses Embedded should be tied to a corresponding user in Embedded. Let’s take an example. Assume your company, ACME Co, has purchased Embedded and is building a Slack integration. A new user called “Joe Smoe joe@example.com” signs up for your platform. In order to enable Embedded for Joe, you’ll need to create a user via the Embedded API. The Create User endpoint takes an email address as input to easily identify the user in question. For any historical users you have on your platform prior to ACME Co using Embedded, you’ll want to create the relevant Embedded users too. Creating a new user in Embedded returns a unique username. We recommend storing this username somewhere in your database; you can however reference it anytime you like by using our Get User or List Users endpoints. As mentioned above, a best practice when using Embedded would be to create users for all old and new merchants. While accounts can be created on-demand, proactive creation allows you to catch email conflicts and speed up the merchant flow upon the first integration installation.

​
Managing User Tokens

Once the user is created, in order to render the Embedded modal, you’ll want to generate a User Token. The User Token is a JSON Web Token (JWT) that is required to securely render the Embedded Modal in your application and must be regenerated every time you want to show the modal.
Note: Token RefreshRemember that you must invoke the User Token endpoint every time you want to render the Embedded modal. For security, the JWT generated only lasts a maximum of 30 minutes.

​
Listing and Finding Users

We provide a List Users and Get User endpoints. Using these endpoints, you can lookup any user by their userId.

​
Deleting Users

While rare, if you need to delete a user you can do so at this endpoint using their userId. Deleting a user removes their account, credentials, and all associated workflows.
⌘I