Skip to main content
GET
/
v2
/
webhooks
List Webhooks
curl --request GET \
  --url https://api.kausate.com/v2/webhooks \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "api_version": "<string>",
    "status": "active",
    "org_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "partner_customer_id": "<string>",
    "custom_headers": {}
  }
]

Authorizations

X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

Response

200 - application/json

Successful Response

id
string<uuid>
required

Webhook ID

name
string
required

Name of the webhook

url
string
required

URL to receive webhook notifications

api_version
string
required

API version for the webhook

status
enum<string>
required

Webhook status

Available options:
active,
inactive
org_id
string
required

Organization ID

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

description
string | null

Optional description

partner_customer_id
string | null

Optional partner customer ID

custom_headers
Custom Headers · object

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