Create a webhook

Creates a new webhook.

POST/v3/webhooks

JWT

webhook:write

Request Body Schema

Property	Type	Description	Constraints
name*	string	Name of the webhook.	min: 1, max: 256
url*	string	The endpoint which will receive the HTTP POST payload.	min: 1, max: 256, format: uri
token*	string	The secret which will be used to sign the payload using HMAC256 algorithm.	min: 1, max: 256
enabled*	boolean	Whether webhook is enabled, you can use it to disable a webhook.
events*	array	The list of events which trigger the webhook.	items: string

Request Example

{
  "name": "string",
  "url": "http://example.com",
  "token": "string",
  "enabled": true,
  "events": [
    "string"
  ]
}

Triggers webhook: webhook.created

POST <your-webhook-url>
{
  "event": "webhook.created",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "url": "string",
    "token": "string",
    "enabled": true,
    "status": "healthy",
    "events": [
      "string"
    ]
  },
  "triggeredAt": "string"
}

Responses

201

400

401

403

409

429

500

201 Created

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "url": "string",
  "token": "string",
  "enabled": true,
  "status": "healthy",
  "events": [
    "string"
  ]
}