About the Events API
You can use the Events API to store and access user event data generated in one or more systems or applications used by your organization. For example, you can track user events that occur in your company's business-to-consumer (B2C) application as well as in a third-party app your company uses for customer billing.
You can then use the event data to build solutions that create better relationships with your customers. The possibilities include:
- Giving your company more context about the customer in one-on-one conversations
- Following up with the customer after certain events
- Providing a more personalized user experience in your application or system
Developer resources
Getting access to the Events API
Get a Zendesk Support account on a Zendesk Suite plan. It is automatically enabled to use the API.
You can try out the Zendesk platform with a free, 14-day trial account. See https://www.zendesk.com/register/free-trial/.
You'll also need agent or admin permissions in the account to use the API.
Enabling events
If you push an event, you must first enable that event in Admin Center before you can view it in the user's interaction history. You must have admin permissions or ask somebody who has those permissions to make these changes.
-
In Admin Center, click the People icon in the sidebar, then select Configuration > Events.
-
Click the Show checkbox for the event you want to include in a user's interaction history.
-
Click Save.