Sign in

v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Webhooks

Update a webhook

Update webhook URL, events, or status. Requires a secret key (sk_).

patch/v1/webhooks/{id}

Path parameters

idstring required

Webhook ID

Request body

urlstring uri

New webhook URL

eventsstring[]

Events to subscribe to

descriptionstring
isActiveboolean

Enable/disable the webhook

Response

Webhook updated

idstring required

Unique identifier for the webhook

urlstring uri required

The HTTPS endpoint that receives webhook payloads

eventsstring[] required

List of event types this webhook subscribes to

isActiveboolean required

Whether the webhook is currently receiving events

secretstring

Secret key for verifying webhook signatures (only returned on creation)

descriptionstring

Optional description for this webhook

createdAtstring date-time

When the webhook was created

Example response

{
  "id": "whk_abc123def456",
  "url": "https://api.example.com/webhooks/drip",
  "events": [
    "charge.succeeded",
    "charge.failed",
    "customer.balance.low"
  ],
  "isActive": true,
  "secret": "whsec_abc123...",
  "description": "Production billing events",
  "createdAt": "2024-01-15T10:30:00.000Z"
}