Webhooks, events and audit
The endpoints that receive the organization events, the deliveries and their retries, the event history and the audit log.
Families on this page
| Family | Tools | read | write | destructive |
|---|---|---|---|---|
webhooks — Webhooks | 9 | 3 | 2 | 4 |
webhook-deliveries — Webhook deliveries | 2 | 2 | 0 | 0 |
events — Events | 2 | 2 | 0 | 0 |
audit-logs — Audit log | 3 | 3 | 0 | 0 |
webhooks
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dashboards_webhooks_list | read | webhooks.list | GET /v1/webhooks | List the webhook endpoints of the workspace, newest first, each with its delivery_count. |
dashboards_webhooks_get | read | webhooks.show | GET /v1/webhooks/:id | Fetch one webhook endpoint by id: URL, subscribed events, auth type, active flag and delivery count. |
dashboards_webhooks_create | write | webhooks.create | POST /v1/webhooks | Create an active webhook endpoint in the workspace subscribed to the given event types. |
dashboards_webhooks_update | write | webhooks.update | PATCH /v1/webhooks/:id | Update a webhook endpoint — URL, description, subscribed events, active (pause/resume), or authentication (auth_type with its auth_config). |
dashboards_webhooks_delete | destructive | webhooks.delete | DELETE /v1/webhooks/:id | Delete a webhook endpoint for good, together with its delivery log. |
dashboards_webhooks_test | destructive | webhooks.update | POST /v1/webhooks/:id/test | Send a signed test.webhook event to the endpoint's URL now and record it in its delivery log. |
dashboards_webhooks_rotate_secret | destructive | webhooks.update | POST /v1/webhooks/:id/rotate_secret | Replace the signing secret of a webhook endpoint. |
dashboards_webhooks_deliveries_list | read | webhooks.show | GET /v1/webhooks/:id/deliveries | List the delivery log of one webhook endpoint, newest first: status, HTTP status, attempts, request and response. |
dashboards_webhooks_deliveries_retry | destructive | webhooks.update | POST /v1/webhooks/:id/deliveries/:delivery_id/retry | Queue a webhook delivery to be sent again to its endpoint (it goes back to pending). |
webhook-deliveries
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dashboards_webhook_deliveries_list | read | webhooks.list | GET /v1/webhook_deliveries | List webhook deliveries across every endpoint of the workspace, newest first, each with its event_type and endpoint summary. |
dashboards_webhook_deliveries_get | read | webhooks.show | GET /v1/webhook_deliveries/:id | Fetch one webhook delivery by id: event type, endpoint, status, HTTP status, attempts, the (redacted) request and the response body. |
events
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dashboards_events_list | read | events.list | GET /v1/events | List the event log — the events webhooks are dispatched from — of the workspace plus organization-level events, newest first. |
dashboards_events_get | read | events.show | GET /v1/events/:id | Fetch one event by id, with its full payload (data) and metadata. |
audit-logs
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dashboards_audit_logs_list | read | audit.list | GET /v1/audit_logs | List the audit trail — who changed what, when, from which IP — of the workspace plus organization-level entries, newest first. |
dashboards_audit_logs_get | read | audit.show | GET /v1/audit_logs/:id | Fetch one audit entry by id, with its previous and new values, changes and request metadata. |
dashboards_audit_logs_summary | read | audit.export | GET /v1/audit_logs/summary | Summarize audit activity over the last hours hours (default 24): total entries, the 10 most frequent actions with counts, and the 20 most recent entries. |
The fields of each resource are in the API reference and in dashboards_schemas_get.
A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.