In most cases, you will want to handle user signup in one of two ways:
Manually create users to allow them access to your Frontly apps
Allow users to sign up on their own at the /signup link in your app
For more advanced cases that involve external platforms and automations, Frontly has a 'Create User' webhook that can be enabled to allow automated user registration, triggered by an external action in a third-party platform.
Enable Webhooks
To use either the Create or Edit Api endpoints, you'll need to enable them for your app by going to the Advanced Settings page.
You will find separate toggles for Allow Create User Webhook and Allow Edit User Webhook. For security, only enable the ones you're using.
Configuration
Webhook base URL (POST):
Required POST body parameters:
api_key
The Frontly-generated unique API Key for your organization. Can be found in the API Settings in the Frontly admin dashboard.
subdomain
The Frontly subdomain of the app you are creating a user in. This can be found in the General Settings in the Frontly admin dashboard
The email of the new user to create (must be unique to the Frontly system)
password
The password of the new user to create
Password Validation Measures:
Must be at least 8 characters long.
Must be unique and not too similar to your personal information (e.g., username or email).
Cannot be a 'Commonly used' password
Cannot solely consist of numbers
Other Fields
Other fields available are first_name, last_name, and any custom user fields you've created in your Frontly admin.
How To Use the Webhook
Reminder: This is an advanced feature, which requires the understanding of APIs and HTTP Requests. Frontly cannot provide direct support / assistance for API request setup in third-party platforms.
To use the webhook, you simply need to make a POST request from a third-party platform to the webhook URL provided above, including the required parameters.
If successful, you will receive a response object with the new user data.
If unsuccessful, you will receive a 400 error.
Editing Users via API
In addition to the 'Create' endpoint, there's also an 'Edit' endpoint located at: https://api.frontly.ai/edit_user_webhook/
The usage is exactly the same as the 'Create User Webhook', except that you don't provide a password field.