Skip to main content

Prerequisites

  • An active Chatbase subscription
  • End user data ready for upload
  • Access to implement end user identification on your website
Chatbase Embed Code Example
1

Upload End User Data

Use the Contacts API endpoint to upload your end user data, and assign an external_id to each contact. This external_id should be used to identify the end user in future conversations.
This external_id should match the user_id you use in your end user identification step. Also, the data associated with the external_id will not be used if the user_hash verification fails. So you don’t need to worry about data privacy.
2

Create Custom Actions

Create custom actions from the dashboard that utilize contact data by referencing fields under the contact. key:
3

Implement End User Identification

Add the identification script to your website and use one of our end user identification methods.For end user verification implementation details, see our Identity Verification Guide.

Security Considerations

  • End user data is only accessible through custom actions that explicitly reference contact fields
  • End user verification is required to access contact data

Best Practices

  1. Data Minimization: Only upload necessary end user data that will be used in AI Agent interactions
  2. Regular Updates: Keep contact data current by updating it when end user information changes
  3. Error Handling: Implement proper error handling for cases where contact data might be unavailable
  4. Testing: Thoroughly test custom actions that use contact data before deploying to production

Implementation Details

For more details on the Contacts API, see the Contacts API guide.
I