Update Webhook

Enable or disable a webhook subscription

PATCH /webhooks/{id}

Update Webhook

cURL

curl --request PATCH \
  --url https://api.kardow.com/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "is_enabled": true
}
'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "target_url": "<string>",
    "is_enabled": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Toggle a webhook subscription on or off without deleting it.

Path Parameters

id · string · required

The subscription ID.

Request Body

is_enabled · boolean · required

Set to true to enable or false to disable the subscription.

Examples

Disable a webhook

cURL

curl --request PATCH \
  --url "https://api.kardow.com/webhooks/your-subscription-id" \
  --header "x-api-key: your-api-key-here" \
  --header "Content-Type: application/json" \
  --data '{"is_enabled": false}'

Response

data · object

Show properties

id · string

Subscription ID

event · string

Event name

target_type · string

Target type

target_url · string

Target URL

is_enabled · boolean

Updated enabled state

updated_at · string

ISO 8601 timestamp

Authorizations

x-api-key · string · header · required

API key for authentication. Get yours from Settings > API Keys in the Kardow dashboard.

Path Parameters

id · string<uuid> · required

Subscription UUID.

Body

application/json

is_enabled · boolean · required

Response

200

application/json

Subscription updated

data · object · required

Show child attributes