Create a webhook subscription

POST/api/v1/webhooks

Requires an Organization API key with the manageMembers capability.

Authorization

apiKey

AuthorizationBearer <token>

In: header

Request Body

application/json

name*string

Length1 <= length <= 120

url*string

Formaturi

Lengthlength <= 2000

eventTypes*array<>

Items1 <= items <= 6

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "http://example.com",    "eventTypes": [      "conversation.escalated"    ]  }'

{  "subscription": {    "id": "string",    "organizationId": "string",    "name": "string",    "url": "string",    "eventTypes": [      "conversation.escalated"    ],    "paused": true,    "createdAt": "string",    "updatedAt": "string"  },  "secret": "string"}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

Create a webhook subscription

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`