v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
webhooks

Api Webhooks Retrieve

GET /api/webhooks/<id>/ - Retrieve webhook details PATCH /api/webhooks/<id>/ - Update webhook DELETE /api/webhooks/<id>/ - Delete webhook

Query Parameters (GET): - is_including_secrets (boolean, optional): Set to 'true' to reveal secrets (default: false)

Request Body (PATCH): - url (string, optional): Update webhook URL - name (string, optional): Update webhook name - active (boolean, optional): Update active status - event_type (string, optional): Update event type

Response: - Webhook object (secrets included only if is_including_secrets=true)

get/api/webhooks/{id}/

Path parameters

idinteger required

Query parameters

is_including_secretsboolean

Set to true to reveal the webhook secret value. Default: false.

Headers

Authorizationstring required

JWT access token or Respan API key

Response

idinteger required
secretsstring required
projectstring nullable
urlstring uri required
namestring
createdstring date-time
activeboolean
organizationinteger required
organization_keystring nullable