Create Webhook

Authorization

api_key

X-API-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Name of the webhook

description?|

Optional description

url*string

URL to receive webhook notifications

Formaturi

Length1 <= length

apiVersion?string

API version for the webhook

Default"v1"

status?string

Webhook status

Default"active"

Value in"active" | "inactive"

partnerCustomerId?|

Optional partner customer ID

customHeaders?|

Custom request headers to include in webhook requests

Response Body

`application/json`

curl -X POST "https://api.kausate.com/v2/webhooks" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "http://example.com"  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "url": "string",
  "apiVersion": "string",
  "status": "active",
  "orgId": "string",
  "partnerCustomerId": "string",
  "customHeaders": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Authorization

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`