API ReferenceWebhooks

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)

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

idintegerRequired

Query parameters

is_including_secretsbooleanOptional

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

Response

idintegerRead-only
secretsstringRead-only
urlstringformat: "uri"<=200 characters
organizationinteger
projectstring or null
namestring<=70 characters
createddatetime
event_typeenum
activeboolean
organization_keystring or null