Sign in

v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB
Webhooks

Create a Webhook

Create a new webhook.

post/webhooks

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

namestring

The name of the webhook.

methodstring

Method used in the webhook.

urlstring

The url of the webhook.

statusstring

The status of the webhook.

databoolean

If yes, send the content of what was done

{"stackTrail":"paths:/webhooks:post:requestBody:content:application/json:schema:properties:actions","oasType":"schema","type":"unknown","description":"The actions that triggers this webhook.","example":null}
{"stackTrail":"paths:/webhooks:post:requestBody:content:application/json:schema:properties:system-collections","oasType":"schema","type":"unknown","description":"The collections that triggers this webhook.","example":null}

Example request

{
  "name": "create articles",
  "method": "POST",
  "status": "active",
  "data": true
}

Response

Successful request