Create a Webhook

Create a new webhook

post

Registers a new webhook to be called each time one or more subscribed event types occur.A HTTP POST request to the webhook URL will be performed for each subscribed event type.The webhook URL must use the https scheme (SSL/TLS). For additional security, headers can be used to specify an authorization header with credentials.For example, basic authentication can easily be applied or any other type of similar authentication schemes.Event Types operationResult Event that signals the completion result of an asynchronous action.

Authorizations

Bearer Token

AuthorizationstringRequired

Header parameters

x-api-keystringRequired

Body

application/json

Contains details as input for creating or updating a webhook.

namestring | nullableOptional

The name of the webhook.

urlstring | nullableOptional

URL for the webhook to send events to.

eventTypesstring[] | nullableOptional

List of event types this webhook subscribes on.

enabledboolean | nullableOptional

Indicates the status of the webhook. If true events will be sent on the webhook, otherwise (false) event sendout is disabled.

Responses

200

Returns a newly created webhook

application/json

400

Bad request

403

Forbidden due to insufficient privileges

409

Webhook already exists, use update

post

/v1/webhooks

HTTPcURLJavaScriptPython

POST /v1/webhooks HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "name": "text",
  "url": "text",
  "eventTypes": [
    "text"
  ],
  "enabled": true,
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "name": "text",
  "url": "text",
  "eventTypes": [
    "text"
  ],
  "enabled": true,
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}