Skip to main content

Topics

This documentation is focused for webhook senders but is also useful for the ones receiving them!

A topic is a logical channel to where webhook messages are sent to. When someone wants to receive webhooks from your system, they will subscribe to a set of topics.

Understanding topics

Let's take, for example, a social network like Twitter. It could publish webhooks to different events, like when a profile tweets, when someone starts following a profile or also when a tweet is deleted.

Usually someone would be interested only in a certain set of events. For instance, someone could be interested in receiving webhooks when someone follows a profile, but not when a profile creates or deletes a tweet.

In that scenario, there could be three topics: The topic tweet:created, tweet:deleted and profile:new_follower. Whomever is interested in receiving webhooks when a new person follows a profile would subscribe to the topic profile:new_follower. Also if they would be interested in receiving a webhook each time a tweet is made, they would also subscribe to the topic tweet:created.

API

Endpoints
GET
/v1/topics
GET
/v1/topics/:id
POST
/v1/topics
PUT
/v1/topics/:id
Resource attributes
name*
string
The resource unique name
public_description
string
The description to your subscribers of what is published to this topic.
webhook_definition*
name|id
The WebhookDefinition object that determines behaviors for webhooks sent to this topic