Sign in

v1

latestOpenAPI 3.0.02026-08-04265791.1 MB
Webhooks

Create

Creating webhooks.

  • note: The body can accept a filter for the webhook based on the chosen topic. The filter can be about any filterable property of the objects from this topic (example: campaign_id for topic missions)
post/public/api/webhooks

Headers

Acceptstring

e.g. application/json

Request body

urlstring
topicsstring[]
operationsstring[]

Example request

{
  "url": "https://webhook.site/b258e106-5aa3-4b86-9eef-a942643243a8",
  "topics": [
    "missions"
  ],
  "operations": [
    "create"
  ],
  "filter": {
    "campaign_id": "6548ec4dee43840028a59a56"
  }
}

Response

OK

webhook_idstring
urlstring
topicsstring[]
operationsstring[]
is_activeboolean
created_datestring
updated_datestring

Example response

{
  "webhook_id": "5ea689b6bd436e37567caffe",
  "url": "https://webhook.site/b258e106-5aa3-4b86-9eef-a942643243a8",
  "topics": [
    "missions"
  ],
  "operations": [
    "create"
  ],
  "is_active": true,
  "created_date": "2020-04-27T07:28:54.324Z",
  "updated_date": "2020-04-27T07:28:54.324Z"
}