Skip to main content
POST
/
v2
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.kausate.com/v2/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "description": "<string>",
  "apiVersion": "v1",
  "status": "active",
  "partnerCustomerId": "<string>",
  "customHeaders": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "apiVersion": "<string>",
  "status": "active",
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "partnerCustomerId": "<string>",
  "customHeaders": {}
}

Authorizations

​
X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

Body

application/json

Request model for creating a webhook.

​
name
string
required

Name of the webhook

​
url
string<uri>
required

URL to receive webhook notifications

Minimum string length: 1
​
description
string | null

Optional description

​
apiVersion
string
default:v1

API version for the webhook

​
status
enum<string>
default:active

Webhook status

Available options:
active,
inactive
​
partnerCustomerId
string | null

Optional partner customer ID

Maximum string length: 150
​
customHeaders
Customheaders · object

Custom request headers to include in webhook requests

Response

Successful Response

Response model for webhook operations.

​
id
string<uuid>
required

Webhook ID

​
name
string
required

Name of the webhook

​
url
string
required

URL to receive webhook notifications

​
apiVersion
string
required

API version for the webhook

​
status
enum<string>
required

Webhook status

Available options:
active,
inactive
​
orgId
string
required

Organization ID

​
createdAt
string<date-time>
required

Creation timestamp

​
updatedAt
string<date-time>
required

Last update timestamp

​
description
string | null

Optional description

​
partnerCustomerId
string | null

Optional partner customer ID

​
customHeaders
Customheaders · object

Custom request headers (including Authorization) to include in webhook requests