Overview

​

What are contacts?

Contacts represent your own users on Chatbase. Unlike visitors, users who are signed up to your business can be identified and linked to contacts using one of our user identification methods. Contact data can then be used by the agent to perform actions on behalf of the user while ensuring their data remains secure.

A contact object can be linked to a user by verifying the user’s identity securely by using a user_id that matches the external_id of a contact.

Once a contact is linked to a user, the contact object stored in Chatbase will be available for use in your chatbot’s custom actions. You typically use the Contacts API to upload user data to Chatbase and keep the in sync with your external system/database, and then use the Contacts dashboard to manage them.

Each contact comes with a set of default fields, here is the list of default fields:

• id - The unique identifier for the contact in chatbase
• external_id - The unique identifier for the contact in your external system/database
• name - Optional The name of the contact
• email - Optional The email of the contact
• phonenumber - Optional The phone number of the contact
• created_at - The date and time the contact was created in chatbase
• updated_at - The date and time the contact was last updated in chatbase

Typically you would upload the contact data to Chatbase through the Contacts API and then use the Contacts dashboard to manage them.

​

What is Contacts API?

Contacts API is a secure way to store and manage your users data that can be accessed by your chatbot during conversations. This feature enables personalized interactions while maintaining data privacy and security.

​

Key Benefits

• Secure storage of user data
• Personalized chatbot conversations
• Integration with custom actions
• Data privacy compliance

For more details on the Contacts API, and how to use it, see the Contacts API guide.

---

​

Contacts Dashboard

Using the Contacts dashboard, you can manage your chatbot contacts in one place. This feature enables you to:

• Upload user data from your system (coming soon)
• View and filter through your contacts
• Manage your contact custom attributes schema

---

​

When should I use the Contacts Data?

Contacts Data is an advanced feature that is particularly useful in the following scenarios:

• Advanced use cases requiring access to private contact data that you do not want to expose to the chatbot in the browser
• Integration with third-party systems (e.g., internal databases, payment systems)
• Custom workflows where standard actions are insufficient
• Keep in mind you can use the Contacts API to:
  • Sync customer data between your system and Chatbase
  • Maintain a single source of truth for contacts information
  • Programmatically manage large numbers of contacts
  • Create personalized chat experiences based on user data
  • Handle complex authentication and authorization requirements