Community post events

This page documents webhook request payloads for Guide community post events. For an overview, see Webhook event types.

Detail object properties

For community post events, the detail object contains the following properties:

• brand_id
• post_id
• topic_id

Event types

The following sections contain example payloads and event object properties for community post event types.

Event type	Payload and properties
zen:event-type:community_post.created	Community Post Created
zen:event-type:community_post.changed	Community Post Changed
zen:event-type:community_post.published	Community Post Published
zen:event-type:community_post.unpublished	Community Post Unpublished
zen:event-type:community_post.subscription_created	Community Post Subscription Created
zen:event-type:community_post.vote_created	Community Post Vote Created
zen:event-type:community_post.vote_changed	Community Post Vote Changed
zen:event-type:community_post.vote_removed	Community Post Vote Removed
zen:event-type:community_post.comment_created	Community Post Comment Created
zen:event-type:community_post.comment_changed	Community Post Comment Changed
zen:event-type:community_post.comment_published	Community Post Comment Published
zen:event-type:community_post.comment_unpublished	Community Post Comment Unpublished
zen:event-type:community_post.comment_vote_created	Community Post Comment Vote Created
zen:event-type:community_post.comment_vote_changed	Community Post Comment Vote Changed

Community Post Created

A community post was created.

{
  "account_id": 13406851,
  "detail": {
    "brand_id": "5761134030206",
    "id": "6997822279934",
    "topic_id": "6997807261054"
  },
  "event": {
    "author_id": "265092602",
    "title": "I'd like a way for users to submit feature requests"
  },
  "id": "01GWT9MPJS85A9VJDPBJT2MD5Z",
  "subject": "zen:community_post:6997822279934",
  "time": "2023-03-30T22:19:03.633133641Z",
  "type": "zen:event-type:community_post.created",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
author_id	integer	The id of the author of the post
title	string	The title of the post

Community Post Changed

A community post was changed.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7007731171070",
    "topic_id": "6996602779134"
  },
  "event": {
    "current": {
      "author_id": "262066642",
      "title": "community post test updated"
    }
  },
  "id": "01GX7NF8XVDSVGCFV2Y45614W4",
  "subject": "zen:community_post:7007731171070",
  "time": "2023-04-05T02:55:56.337787784Z",
  "type": "zen:event-type:community_post.changed",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
current	object	Contains the current post details
current.author_id	integer	The id of the author of the post
current.title	string	The title of the post

Community Post Published

A community post was published.

{
  "account_id": 13344059,
  "detail": {
    "brand_id": "5721289384062",
    "id": "6997899807870",
    "topic_id": "6997899807614"
  },
  "event": {},
  "id": "01GWTCFCZ1XZXTWPQ04A90K8EF",
  "subject": "zen:community_post:6997899807870",
  "time": "2023-03-30T23:08:35.672406763Z",
  "type": "zen:event-type:community_post.published",
  "zendesk_event_version": "2022-11-06"
}

The payload contains an empty event object.

Community Post Unpublished

A community post was unpublished.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7007731171070",
    "topic_id": "6996602779134"
  },
  "event": {},
  "id": "01GX7YZ6ZY9KN4QEJY6JT6MQ3E",
  "subject": "zen:community_post:7007731171070",
  "time": "2023-04-05T05:41:55.829944516Z",
  "type": "zen:event-type:community_post.unpublished",
  "zendesk_event_version": "2022-11-06"
}

The payload contains an empty event object.

Community Post Subscription Created

A user subscribed to a community post.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "subscription": {
      "id": "7009515926526",
      "user_id": "262066642"
    }
  },
  "id": "01GX9XZY5S1H53CFHSR7RA0TRP",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-06T00:03:19.863065898Z",
  "type": "zen:event-type:community_post.subscription_created",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
subscription	object	Contains the post 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

Community Post Vote Created

A vote was added to a community post.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "vote": {
      "user_id": "262066642",
      "value": 1,
      "vote_id": "7008112350462"
    }
  },
  "id": "01GX7Z90PHSCC4ZX3KWD61KVJB",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T05:47:17.071879057Z",
  "type": "zen:event-type:community_post.vote_created",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
vote	object	Contains a vote on the post
vote.user_id	integer	The id of the user who cast this vote
vote.value	string	The value of the vote. Can be -1 or 1
vote.vote_id	integer	An id automatically assigned when a vote is created

Community Post Vote Changed

A vote was changed on a community post.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "current": {
      "user_id": "262066642",
      "value": -1,
      "vote_id": "7008112350462"
    }
  },
  "id": "01GX7ZFD77SCCB9HXQJDT4AC32",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T05:50:46.501839686Z",
  "type": "zen:event-type:community_post.vote_changed",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
current	object	Contains a vote on the post
current.user_id	integer	The id of the user who cast this vote
current.value	string	The updated value of the vote. Can be -1 or 1
current.vote_id	integer	The id of the vote automatically assigned when the vote was created

Community Post Vote Removed

A vote was removed from a community post.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "vote": {
      "id": "7008112350462"
    }
  },
  "id": "01GX7ZFDW0MJDJ4MQCXS1PK6JN",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T05:50:47.166014152Z",
  "type": "zen:event-type:community_post.vote_removed",
  "zendesk_event_version": "2022-11-06"
}

The event object 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

Community Post Comment Created

A community post comment was created.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "comment": {
      "author_id": "262066642",
      "id": "7008068544510"
    }
  },
  "id": "01GX805NSCWE62TNT30Z02JX8M",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T06:02:56.159326386Z",
  "type": "zen:event-type:community_post.comment_created",
  "zendesk_event_version": "2022-11-06"
}

The event object 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

Community Post Comment Changed

A community post comment was changed.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "current": {
      "id": "7008068544510"
    }
  },
  "id": "01GX80ETT141RSXCRXRF824VDY",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T06:07:56.216142115Z",
  "type": "zen:event-type:community_post.comment_changed",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
current	object	Contains the comment details
current.id	integer	The id of the updated comment

Community Post Comment Published

A community post comment was published.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "comment": {
      "id": "7008068544510"
    }
  },
  "id": "01GX805NSGQRA3XQGPQ9PPJVA8",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T06:02:56.165872868Z",
  "type": "zen:event-type:community_post.comment_published",
  "zendesk_event_version": "2022-11-06"
}

The event object 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

Community Post Comment Unpublished

A community post comment was marked as spam, hidden for moderation, or deleted.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "comment": {
      "id": "7008068544510"
    }
  },
  "id": "01GX80NGSA6PSAR42CY9ZH01YF",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T06:11:35.332951873Z",
  "type": "zen:event-type:community_post.comment_unpublished",
  "zendesk_event_version": "2022-11-06"
}

The event object 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

Community Post Comment Vote Created

A vote was added to a community post comment.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "comment": {
      "id": "7008068544510"
    },
    "vote": {
      "id": "7008089204350",
      "user_id": "262066642",
      "value": 1
    }
  },
  "id": "01GX80FRKDKD4WDB1PHGFBPZFC",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T06:08:26.731491134Z",
  "type": "zen:event-type:community_post.comment_vote_created",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
comment	object	Contains details about the comment the vote was added to
comment.id	integer	An id automatically assigned when the comment was created
vote	object	Contains a vote on the community post
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 -1 or 1

Community Post Comment Vote Changed

A vote was changed on a community post comment.

{
  "account_id": 11896485,
  "detail": {
    "brand_id": "4883147156990",
    "id": "7008112307198",
    "topic_id": "6996602779134"
  },
  "event": {
    "comment": {
      "id": "7008068544510"
    },
    "current": {
      "id": "7008103458814",
      "user_id": "262066642",
      "value": 1
    }
  },
  "id": "01GX80KMFETQEPHE3GVV6GQEM6",
  "subject": "zen:community_post:7008112307198",
  "time": "2023-04-05T06:10:33.579877984Z",
  "type": "zen:event-type:community_post.comment_vote_changed",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
comment	object	Contains details about the comment the vote was updated for
comment.id	integer	An id automatically assigned when the comment was created
current	object	Contains a vote on the community post
current.id	integer	An id automatically assigned when the vote was created
current.user_id	integer	The id of the user who cast this vote
current.value	string	The updated value of the vote. Can be -1 or 1