POST
/
v2
/
webhooks
/
subscribe
curl --request POST \
  --url https://api.kadoa.com/v2/webhooks/subscribe \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "webhookUrl": "<string>",
  "webhookHttpMethod": "GET",
  "events": [
    "<any>"
  ]
}'
{
  "id": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key
string
headerrequired

Body

application/json
webhookUrl
string
required

The URL to send the webhook events to

webhookHttpMethod
enum<string>
required

The HTTP method to use for the webhook (GET or POST)

Available options:
GET,
POST
events
any[]
required

The list of events to subscribe to (available events can be fetched over the /events API)

Response

201 - application/json
id
string

The ID of the created webhook subscription

message
string

Success message

Get the list of available events for subscriptionUnsubscribe from webhook events