Configuration

This section provides all the necessary information to understand how to configure webhooks for your application.

Events

A webhook is triggered by one or multiple events that you can subscribe to:

Name
MESSAGE_UPDATED
Type
Description
Triggered when a Message is updated within a Channel.
Name
CONTENT_UPDATED
Type
Description
Triggered when a Post is updated within a Source.
Name
AUTHOR_UPDATED
Type
Description
Triggered when an Author is updated within a Source.

Secret

The secret can be used for security purposes. See the security section for more information.

Contact

Each new webhook subscription requires the contact field. This field is used for alerting purposes if we encounter any issues reaching your endpoint.

The contact must be a user registered to your organization on the dashboard.

Custom headers (optional)

Custom headers allow additional data to be sent through webhooks.

When setting up your webhook, you can provide some Key / Value data that will be forwarded to your endpoint.

Custom headers are NOT intended to forward heavy payloads.

Webhook statuses

Each webhook has a Status that describes its current state. Here are the different values:

Name
ENABLED
Type
Description
Webhook is active and ready to receive Notifications.
Name
DISABLED
Type
Description
Webhook is inactive, notifications won't be sent. This value can be set from the Dashboard.
Name
BROKEN
Type
Description
Webhook is broken, notifications won't be sent. We have attempted to notify your endpoint multiple times without success.

The BROKEN status is automatically set. To enable the webhook again, you will have to check and fix the issue. Once the issue is resolved, you can manually enable it on your dashboard.