The End Users API allows you to update and manage your users’ data in real time. It also comes with webhook events you can subscribe to so you can keep track of changes to user profiles in Ada.
This API allows integrators to:
- Programmatically sync user details from external systems with Ada using webhooks so that Action and Knowledge rules apply to those users
- Get notified at your webhook endpoint when Ada users are created or updated through the API
- Update metavariables using request blocks or Actions
- The
end_user_idis a variable that will fill in this part of the URL programmatically for requests or actions (so you don’t have to consume webhooks unless needed)
- The
The End User Profile entity is represented as a JSON object composed of key,value pairs. Each key in the End User object represents a metavariable you can use throughout Ada. Learn more about metavariables.
You can use the profile.metadata object to create a custom mapping of key,value pairs to reflect your company’s data schema. All values must be strings, integers, or booleans.
The system_properties object includes select keys automatically created by Ada, and is read-only. Note that depending on your Ada configuration, not all keys defined in the End Users API specification may be present or may have values.
The end user profile is composed of metavariables, which may be set through Ada’s embed SDK as well as through the End Users API. Use caution when storing user information in metavariables - they are not intended to replace an authentication flow to verify a user’s identity and information.