Webhooks

How to subscribe to an event

POST /webhooks/{eventName}/subscriptions

All webhook events must be authenticated using an OAuth2 token in the headers: for more information consult the OAuth2 section.

Add the event name you want to subscribe to in the path (e.g. question.Asked).

Add the following details in the body:

{
    "url": "your callback url",
    "username": "your-api-token",
    "secret": "your-api-secret"
}

For more information about the webhook subscription endpoint, see Subscribe URL to webhook event.

Available events

Currently available webhook events are:

• Article events
• Content Moderation events
• Conversation events
• Event events
• Gamification events
• Group events
• Idea events
• Ideation events
• Product update events
• Public Tag events
• Question events
• User events

We have more events available and we're expanding this officially-supported list based on customer request, so please let Customer Communities support know if there's a use case you can't support with the above events.

Private and Public Ids

The public ids identify the topic/reply platform-wide and are used in the community URLS. The public id can be found in most of the events under the following keys:

• publicId for topics
• publicReplyId for replies

The private ids identify the topic/reply internally and are used in the API URLS.The private id can be found in most of the events under the following keys:

• articleId for topics of content type Article
• questionId for topics of content type Question
• conversationId for topics of content type Conversation
• ideaId for topics of content type Idea
• id for topics/replies
• replyId for replies

Permalink

Content webhook payloads may include absolute community URLs. Topic URLs use {baseUrl}/{categorySlug-categoryId}/{titleSlug-publicTopicId} (or /ideas/ / /product-updates/ when no category applies). Reply URLs append ?postid={publicReplyId}#post{publicReplyId}.

• topic_permalink — topic-level events
• reply_permalink — reply-level events
• topic_permalink and reply_permalink — e.g. answered, answer removed
• source_permalink and destination_permalink — moved, converted events