Create a webhook

Create webhook

POST https://<your_gateway_host>/api/webhook

Request Body

Name	Type	Description
url	string	The HTTP or HTTPS URL where the callbacks will be sent via POST request
description	string	Description for the webhook
enabled	string	true | false - if true, then the webhook will be enabled

200 Successfully created webhook

{
  "message": "webhook created",
  "data": [
    {
      "id": "faa47035-b162-41e7-9b7c-19a5d43b2d2a",
      "created_at": "2021-04-08T10:58:33.934Z",
      "updated_at": "2021-04-08T10:58:33.934Z",
      "url": "https://mydomain.ltd",
      "description": "",
      "secret": "159ad2d872",
      "enabled": true
    }
  ]
}

Raw body

{
  "url": "https://mydomain.ltd",
  "description": "",
  "enabled": true
}

Webhook endpoints must be publicly accessible so Platform can send unauthenticated requests. You should always validate sender's (Platform) identity by verifying signature. Learn more here