v1

latestOpenAPI 3.0.02026-08-04265791.1 MB

Webhooks

Partial Update

Update a subset of properties of a webhook

patch/public/api/webhooks/{id}

Path parameters

idstring required

The id of the webhooks

Headers

Acceptstring

e.g. application/json

Request body

is_activeboolean

Example request

{
  "is_active": false
}

Response

webhook_idstring

urlstring

topicsstring[]

is_activeboolean

created_datestring

updated_datestring

Example response

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