Article events
This page documents webhook request payloads for Guide article events. For an overview, seeWebhook event types.
Detail object properties
For article events, thedetailobject contains the following properties:
idbrand_id
Event types
The following sections contain example payloads andeventobject properties for article event types.
| Event type | Payload and properties |
|---|---|
| zen:event-type:article.author_changed | Article Author Changed |
| zen:event-type:article.published | Article Published |
| zen:event-type:article.subscription_created | Article Subscription Created |
| zen:event-type:article.unpublished | Article Unpublished |
| zen:event-type:article.vote_created | Article Vote Created |
| zen:event-type:article.vote_changed | Article Vote Changed |
| zen:event-type:article.vote_removed | Article Vote Removed |
| zen:event-type:article.comment_created | Article Comment Created |
| zen:event-type:article.comment_changed | Article Comment Changed |
| zen:event-type:article.comment_published | Article Comment Published |
| zen:event-type:article.comment_unpublished | Article Comment Unpublished |
Article Author Changed
A help center article's author was changed.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"current":"6998057797118"},"id":"01GX7773HNJ9CA89HX2P1MQ8E1","subject":“zen:article:7005450498174","time":"2023-04-04T22:46:48.627504986Z","type":“zen:event-type:article.author_changed",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| current | integer | Contains the currentauthor_id |
Article Published
A help center article was published.
{{"account_id":10168721,"detail":{"brand_id":"224348602","id":"7005414006398"},"event":{"author_id":"225859532","category_id":"7005437869694","locale":"en-us","section_id":"7005437870078","title":"Dolor est quo ratione."},"id":"01GX4P86AC7T0AFF86QGAHTEFR","subject":“zen:article:7005414006398","time":"2023-04-03T23:11:49.571545199Z","type":“zen:event-type:article.published",“zendesk_event_version":"2022-11-06"}}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| author_id | integer | The id of the article's author |
| category_id | integer | The id of the category to which the article belongs |
| locale | string | The article's locale |
| section_id | integer | The id of the section to which the article belongs |
| title | string | The article's title |
Article Subscription Created
帮助中心的一篇文章订阅了。
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"6996623598974"},"event":{"subscription":{"id":"7009486288254","user_id":"262066642"}},"id":"01GX9X40NW14K6WMKQRJDR15EB","subject":“禅:文章:6996623598974”,"time":"2023-04-05T23:48:04.922543199Z","type":“zen:event-type:article.subscription_created",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| subscription | object | Contains the article subscription |
| subscription.id | integer | An id automatically created when a subscription is created |
| subscription.user_id | integer | The id of the user who has this subscription |
Article Unpublished
A help center article was unpublished.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{},"id":"01GX4PA0K4TC01K8AVSC3FW2ES","subject":“zen:article:7005450498174","time":"2023-04-03T23:12:49.245377265Z","type":“zen:event-type:article.unpublished",“zendesk_event_version":"2022-11-06"}
The payload contains an emptyeventobject.
Article Vote Created
A vote was added to a help center article.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"vote":{"id":"7007394906238","user_id":"262066642","value":1}},"id":"01GX787AW4SB2K793VM2T37X2Y","subject":“zen:article:7005450498174","time":"2023-04-04T23:04:24.706715957Z","type":“zen:event-type:article.vote_created",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| vote | object | Contains a vote on the article |
| vote.id | integer | An id automatically assigned when a vote is created |
| vote.user_id | integer | The id of the user who cast this vote |
| vote.value | string | The value of the vote. Can be-1or1 |
Article Vote Changed
A vote was changed on a help center article.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"current":{"id":"7007394906238","user_id":"262066642","value":-1}},"id":"01GX789JJXA5QSGQPK3XHB876Y","subject":“zen:article:7005450498174","time":"2023-04-04T23:05:38.139607714Z","type":“zen:event-type:article.vote_changed",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| current | object | Contains the current vote details |
| current.id | integer | The id of the vote that was changed |
| current.user_id | integer | The id of the user who cast this vote |
| current.value | string | The updated value of the vote. Can be-1or1 |
Article Vote Removed
A vote was removed from a help center article.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"vote":{"id":"7007394906238"}},"id":"01GX78A5SNQ3310ZYYKDHZEFC9","subject":“zen:article:7005450498174","time":"2023-04-04T23:05:57.811184776Z","type":“zen:event-type:article.vote_removed",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| vote | object | Contains the vote details |
| vote.id | integer | An id automatically assigned when the vote was created |
Article Comment Created
A help center article comment was created.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"comment":{"author_id":"262066642","id":"7007443108862","locale":"en-us"}},"id":"01GX79ST1QX01C889XV42S2J5T","subject":“zen:article:7005450498174","time":"2023-04-04T23:31:58.642630335Z","type":“zen:event-type:article.comment_created",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| comment | object | Contains the comment details |
| comment.author_id | integer | The id of the author of the comment |
| comment.id | integer | An id automatically assigned when the comment is created |
| comment.locale | string | The locale in which the comment was made |
Article Comment Changed
A help center article comment was edited.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"current":{"id":"7007443108862"}},"id":"01GX7A6DJ7ZKDVQVMQ3AFHR4QJ","subject":“zen:article:7005450498174","time":"2023-04-04T23:38:51.834140851Z","type":“zen:event-type:article.comment_changed",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| current | object | Contains the comment details |
| current.id | integer | The id of the comment that was updated |
Article Comment Published
A help center article comment was published.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"comment":{"id":"7007443108862","locale":"en-us"}},"id":"01GX79ST1VZRDG815C7450Y42M","subject":“zen:article:7005450498174","time":"2023-04-04T23:31:58.645534016Z","type":“zen:event-type:article.comment_published",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| comment | object | Contains the comment details |
| comment.id | integer | An id automatically assigned when the comment was created |
| comment.locale | string | The locale in which the comment was made |
Article Comment Unpublished
A help center article comment was marked as spam, hidden for moderation, or deleted.
{"account_id":11896485,"detail":{"brand_id":"4883147156990","id":"7005450498174"},"event":{"comment":{"id":"7007443108862","locale":"en-us"}},"id":"01GX7ABVG0B7WDDXEKJNJ30ZVN","subject":“zen:article:7005450498174","time":"2023-04-04T23:41:49.918525172Z","type":“zen:event-type:article.comment_unpublished",“zendesk_event_version":"2022-11-06"}
Theeventobject contains the following properties.
| Property | Data type | Description |
|---|---|---|
| comment | object | Contains the comment details |
| comment.id | integer | An id automatically assigned when the comment was created |
| comment.locale | string | The locale in which the comment was made |