An event is a description of an activity that has occurred, such as when a user’s name is changed, or when a support request is created. They can be retrieved using the Events API, or viewed in the customer context in the Zendesk Agent Workspace.

Supported events

The following table lists the supported Zendesk events. See the sections below for event details and examples.

Event typeZendesk productDescription
identity_createdSupportA new identifier was added to a user
identity_changedSupportA user’s identifier was updated
name_changedSupportA user’s name was updated
details_changedSupportA user’s details were updated
notes_changedSupportA user’s notes were updated
organization_addedSupportAn organization was added to the user
organization_removedSupportAn organization was removed from the user
user_mergedSupportA user was merged with another user
user_suspension_changedSupportA user was suspended
ticket_requestedSupportA Support ticket was requested
ticket_requester_changedSupportA ticket requester was changed
answers_suggestedGuideThe number of articles suggested to the user while creating a support request
article_instant_search_result_clickedGuideThe article link was clicked in the help center dropdown search results
article_search_result_clickedGuideThe article link was clicked in the help center search results
article_viewedGuideThe help center article was viewed
help_center_searchedGuideA user searched the help center using the search bar
suggested_article_clickedGuideArticle suggested to the user was clicked while submitting a support request
article_subscribedGuideA user subscribed to an article
article_vote_addedGuideA user added a vote for an article
article_comment_createdGuideA user added a comment for an article
community_post_viewedGatherA community post was viewed
community_search_result_clickedGatherA community post search result was clicked
community_post_createdGatherA community post was created
community_post_vote_addedGatherA user added a vote for a community post
community_post_subscribedGatherA user subscribed to a community post
community_comment_createdGatherA user added a comment for a community post
community_comment_vote_addedGatherA user added a vote for a community post comment
page_viewSDKsA page was viewed where the Web Widget or SDK is installed

SDK Events

Page viewed

A page was viewed where the Web Widget or SDK is installed. Page views are displayed to agents in the customer context panel for Zendesk messaging customers.

Rate limits

Page view events are limited to 1,000 events per minute. Any additional page views beyond this limit will not be recorded.

Example

Status 200 OK
{            "id": "01FY8J3D3X6GWKGR9M14PP6D1Q",            "type": "page_view",            "source": "zendesk",            "description": "",            "created_at": "2022-03-16T05:09:39.328Z",            "received_at": "2022-03-16T05:09:39.593225847Z",            "properties": {                "channel": "web_messenger",                "device_id": "7e124a8b13a24635881812ah6f5188ce",                "referrer": "https://some-website.com/en-us/articles/How-do-I-publish-my-content",                "session_id": "2e40d024khsa498b81452a70bb693b1e9",                "title":