Get a webhook
This API method returns a single webhook, including its last delivery. Requires webhooks:read. The signing secret is never returned here.
Errors: 403 FORBIDDEN (the key owner no longer exists) and 404 WEBHOOK_NOT_FOUND (the webhook does not exist, or it is owned by another user and the key owner is not an admin).
Authorization
bearerAuth webhooks:readAPI key sent as Authorization: Bearer vt_live_<secret>. See the Authentication and Scopes sections at the top of this document for how keys are created, which scopes exist and how the key owner's role limits them.
In: header
Scope: webhooks:read
Path Parameters
webhook ID.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/webhooks/wh_3f1c2b9e-8a47-4d5e-9c61-2b7f0e4a1d93"{
"data": {
"webhookId": "wh_3f1c2b9e-8a47-4d5e-9c61-2b7f0e4a1d93",
"url": "https://example.com/vacation-tracker/webhooks",
"description": "Sync leaves to payroll",
"events": [
"leave.approved",
"leave.cancelled"
],
"status": "active",
"pausedReason": null,
"pausedAt": null,
"revokedAt": null,
"revocationReason": null,
"ownerId": "user-63b17e97-d38b-4586-8498-bb4f5d2e2c14",
"secretPrefix": "whsec_AbCd",
"lastDelivery": {
"deliveryId": "dlv_1790157600000_8a47c61e2b7f4d5e9c613f1c2b9e1d93",
"eventName": "leave.approved",
"status": "SUCCEEDED",
"responseStatus": 200,
"at": "2026-09-23T10:00:00.000Z"
},
"createdAt": "2026-09-01T08:00:00.000Z",
"updatedAt": "2026-09-23T10:00:00.000Z"
}
}{
"error": {
"code": "UNAUTHORIZED",
"name": "Unauthorized",
"description": "The API key is missing, malformed or not recognized.",
"resolution": "Send a valid API key in the Authorization header as Bearer followed by the full vt_live_ key.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}{
"error": {
"code": "INSUFFICIENT_SCOPE",
"name": "InsufficientScope",
"description": "The API key does not have the scopes this request needs.",
"resolution": "Add the scopes listed in details.requiredScopes to the key in the Vacation Tracker dashboard.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
"details": {
"requiredScopes": [
"leaves:write"
]
}
}
}{
"error": {
"code": "WEBHOOK_NOT_FOUND",
"name": "Webhook not found",
"description": "The webhook was not found.",
"resolution": "Check the webhook ID.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}{
"error": {
"code": "RATE_LIMITED",
"name": "RateLimited",
"description": "Too many requests were sent in a short time.",
"resolution": "Wait a few seconds and retry, using the same Idempotency-Key for writes.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"name": "InternalError",
"description": "Something went wrong on our side.",
"resolution": "Retry later, and if it keeps happening, contact Vacation Tracker support and quote the requestId.",
"requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
}
}Need help?
developers@vacationtracker.ioCreate a webhook
This API method creates a webhook owned by the key owner and returns it with 201 and its signing secret (whsec_...). Requires webhooks:write. **The secret is shown only in this response**; store it securely, and use POST /v2/webhooks/{id}/rotate-secret if you lose it. The webhook is created active.
Update a webhook
This API method changes a webhook's url, events or description and returns the webhook with 200. Requires webhooks:write. Send only the fields you want to change; at least one field is required. Fields you do not send keep their current values.