Skip to content

Webhook

8 endpoints in this module.

Method Path Auth Permissions Roles Description
GET /api/webhooks jwt WEBHOOKS_READ List all webhook configurations for the current tenant
GET /api/webhooks/:id jwt WEBHOOKS_READ Get a specific webhook configuration by ID
POST /api/webhooks jwt WEBHOOKS_WRITE Create a new webhook configuration (returns signing secret once)
PATCH /api/webhooks/:id jwt WEBHOOKS_WRITE Update webhook configuration (name, URL, events, status, description)
POST /api/webhooks/:id/rotate-secret jwt WEBHOOKS_WRITE Rotate the webhook signing secret (returns new secret once)
DELETE /api/webhooks/:id jwt WEBHOOKS_WRITE Delete a webhook configuration permanently
GET /api/webhooks/:id/deliveries jwt WEBHOOKS_READ List delivery attempts for a specific webhook configuration
POST /api/webhooks/deliveries/:deliveryId/retry jwt WEBHOOKS_WRITE Manually retry a dead-lettered webhook delivery

Source: apps/api/src/modules/webhook/webhook.controller.ts