Create a webhook

POST /api/2.0/settings/webhook

Request

Creates a new tenant webhook with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Webhook request parameters

idintegerformat: int32

ID

namestringrequired

Name

uristringformat: urirequired

URI

secretKeystring

Secret key

enabledboolean

Enabled or not

sslboolean

SSL

Examples

POST /api/2.0/settings/webhook HTTP/1.1
Accept: application/json
Content-Length: 125
Content-Type: application/json
Host: example.com

{
  "id": 7063,
  "name": "Laverna Kub",
  "uri": "some text",
  "secretKey": "some text",
  "enabled": true,
  "ssl": true
}

curl --request POST \
  --url https://example.com/api/2.0/settings/webhook \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 7063,
  "name": "Laverna Kub",
  "uri": "some text",
  "secretKey": "some text",
  "enabled": true,
  "ssl": true
}'

Responses

200

Tenant webhook with its config parameters

idintegerformat: int32

ID

namestring

Name

uristring

URI

secretKeystring

Secret key

enabledboolean

Specifies if the webhooks are enabled or not

sslboolean

SSL

401

Unauthorized

403

Forbidden