Overview

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_id is 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).

User Profile Structure

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.

Webhook Support

Ada supports event notifications that enable you to track specific user actions and updates. The following events are currently supported:

• v1.end_user.created: Triggered when a new user is created through any of Ada’s supported channels. The bot’s customer persistence setting influences the rate of these events.
• v1.end_user.updated: Triggered when a value on the end user’s profile changes. Updates may occur via:
  • API calls (e.g., PATCH requests to the End Users API).
  • Updates through Ada-supported channels (e.g., setMetafields on embeds).
  • Profile field mappings from Sunshine Conversations.

Changes That Do Not Trigger Events

Certain updates do not generate end_user.updated events:

• Changes to system.properties.
• Modifications to metavariables like:
  • ip_address
  • user_agent
  • browser
  • device
  • last_answer_id
  • channel_status

For more details on how to implement and use webhooks, refer to the webhook documentation.