webhook

Update a webhook

Updates a webhook's URL, name, event types, active status or retry policy.

event_type and retry_policy replace their current values. Send the ETag you read as If-Match. The signing secret does not change.

patch/webhook/{webhook}

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/webhook/{webhook}
  • Auth: HTTP bearer

Path parameters

webhookstring required

The webhook's id, whk_....

Headers

If-Matchstring nullable

The ETag from your last read of the webhook. A stale value is refused with 409.

Request body

urlstring nullable

The URL deliveries are sent to. Pending deliveries go to the new URL.

namestring nullable

A name for the webhook, up to 200 characters. null clears it.

event_typestring[] nullable

The complete list of event types to deliver. Replaces the current list.

activeboolean nullable

Whether events are delivered. While false, deliveries are held.

Response

The webhook.

object'webhook' required

The object's type. Always webhook.

idstring required

Unique identifier for the object.

namestring nullable required

The webhook's name. Null when none was given.

urlstring required

The URL deliveries are sent to.

event_typestring[] required

The event types delivered to this webhook.

activeboolean required

Whether events are delivered. While false, deliveries are held.

secret_fingerprintstring required

A fingerprint of the signing secret, for telling secrets apart.

created_atstring date-time required

Time at which the object was created.

updated_atstring date-time required

Time at which the object was last updated.

hrefstring required

The path of this webhook.

Example response

{
  "id": "whk_01h455vb4pex5vsknk084sn02q",
  "name": "Production",
  "url": "https://example.com/webhooks/placestack",
  "secret_fingerprint": "9f86d081",
  "href": "/webhook/whk_01h455vb4pex5vsknk084sn02q"
}

Changes

No recorded changes to this operation across all 1 revision of this API.