Webhooks

Use Interact webhooks to notify your application over HTTP when content changes or social interactions occur, without polling the REST API.

Overview

A webhook is a user-defined callback over HTTP. You can use Interact webhooks to notify your app or web application when certain events occur in Interact. For example, you might alert your remote application when a page is updated or a comment is made on a gallery image. Using a webhook means your remote application does not have to periodically poll Interact via the REST API to determine whether changes have occurred.

Interact webhooks cover two scopes:

Content changes — changes to content held or referenced within Interact, for example the addition of a page or calendar event.
Social interactions — social conversations that take place within Interact, typically relating to content, for example a comment on a gallery image.

The payload

When a subscribed event occurs, Interact sends an HTTP POST with a JSON body to the listener URL you provide. Each payload shares a common envelope — the webhook name, the time it was generated, and a data object describing the change, with the affected item in data.documentdata. See SearchIndexDelete for the envelope, and each event page below for the documentdata it carries.

Next steps

Configuring a webhook — request a webhook and provide the listener URL.
SearchIndexAddUpdate — payload for items added to or updated in the search index.
SearchIndexDelete — payload for items removed from the search index.
NewsfeedAddUpdate — payload for items added to or updated in the Timeline.
PageDeleted — payload for a page that is deleted.
PageSoftDeleted — payload for a page that is soft-deleted.

Section: Integrations