Before you begin

Before you set up your webhook, make sure you have everything you need:

• API spec
• Swagger UI or Postman to make a PATCH request
• An Ada dashboard with the Test Bot enabled (or any other supported channel where your bot is active)
• An End Users API token

Set up your webhook

1. Set up a test webhook, or bring your own, with Ada’s webhooks manager.
   1. In the Ada dashboard, find your webhook settings.
      • If you're using a generative AI Agent, go to Customization > Integrations > Webhooks > Endpoints.
      • If you're using a scripted bot, go to Settings > Integrations > Webhooks > Endpoints.
   2. Click Add an Endpoint to get started. If you don’t have your own endpoint, configure a test endpoint using Svix Play.
   3. In the Message Filtering section, subscribe to both v1.end_user.updated and v1.end_user.created events.
   4. Click Create to save your endpoint.
2. Open your Test Bot in a new tab or window and start a conversation.
3. In a separate tab, open the Webhooks Logs to monitor new events. You’ll see the conversation with your Test Bot has created an end user! There will be a corresponding log entry called v1.end_user.created.
4. Click on the log to see the webhook event payload and copy the end_user_id value.
5. Make a PATCH request with the following payload:
   JavaScript

   {
     "profile": {
       "first_name": "Ada",
       "last_name": "Lovelace",
       "email": "[email protected]",
       "language": "en-US",
       "metadata": {
         "end_user_api_test": true
       }
     }
   }
   

6. Check the Webhooks Logs tab. A successful PATCH request will generate a v1.end_user.updated log.
7. You can continue to chat with Test Bot while making these changes to the end user. The End Users API can update records at any point whether a conversation is active or not. Go ahead and send a few messages to your bot!
8. Finally, go the Conversations View and find your conversation. You’ll see that the metavariables are updated from the PATCH request.

That’s it! You have the building blocks to create an integration between your customer data platform and Ada’s End Users API. Your integration can ingest webhook events and use the PATCH endpoint to send user details to Ada so that features such as Article Rules can be applied automatically for your end users.