webhook

Retrieve a webhook

Retrieves a webhook's URL, event types, status and retry policy. The signing secret is not included.

Send the response's ETag header as If-Match when you update or delete the webhook.

get/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_....

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.