Skip to main content

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​

FamilyToolsreadwritedestructive
webhooks — Webhooks9324
webhook-deliveries — Webhook deliveries2200
events — Events2200
audit-logs — Audit log3300

webhooks​

ToolKindPermissionEndpointWhat it does
dashboards_webhooks_listreadwebhooks.listGET /v1/webhooksList the webhook endpoints of the workspace, newest first, each with its delivery_count.
dashboards_webhooks_getreadwebhooks.showGET /v1/webhooks/:idFetch one webhook endpoint by id: URL, subscribed events, auth type, active flag and delivery count.
dashboards_webhooks_createwritewebhooks.createPOST /v1/webhooksCreate an active webhook endpoint in the workspace subscribed to the given event types.
dashboards_webhooks_updatewritewebhooks.updatePATCH /v1/webhooks/:idUpdate a webhook endpoint — URL, description, subscribed events, active (pause/resume), or authentication (auth_type with its auth_config).
dashboards_webhooks_deletedestructivewebhooks.deleteDELETE /v1/webhooks/:idDelete a webhook endpoint for good, together with its delivery log.
dashboards_webhooks_testdestructivewebhooks.updatePOST /v1/webhooks/:id/testSend a signed test.webhook event to the endpoint's URL now and record it in its delivery log.
dashboards_webhooks_rotate_secretdestructivewebhooks.updatePOST /v1/webhooks/:id/rotate_secretReplace the signing secret of a webhook endpoint.
dashboards_webhooks_deliveries_listreadwebhooks.showGET /v1/webhooks/:id/deliveriesList the delivery log of one webhook endpoint, newest first: status, HTTP status, attempts, request and response.
dashboards_webhooks_deliveries_retrydestructivewebhooks.updatePOST /v1/webhooks/:id/deliveries/:delivery_id/retryQueue a webhook delivery to be sent again to its endpoint (it goes back to pending).

webhook-deliveries​

ToolKindPermissionEndpointWhat it does
dashboards_webhook_deliveries_listreadwebhooks.listGET /v1/webhook_deliveriesList webhook deliveries across every endpoint of the workspace, newest first, each with its event_type and endpoint summary.
dashboards_webhook_deliveries_getreadwebhooks.showGET /v1/webhook_deliveries/:idFetch one webhook delivery by id: event type, endpoint, status, HTTP status, attempts, the (redacted) request and the response body.

events​

ToolKindPermissionEndpointWhat it does
dashboards_events_listreadevents.listGET /v1/eventsList the event log — the events webhooks are dispatched from — of the workspace plus organization-level events, newest first.
dashboards_events_getreadevents.showGET /v1/events/:idFetch one event by id, with its full payload (data) and metadata.

audit-logs​

ToolKindPermissionEndpointWhat it does
dashboards_audit_logs_listreadaudit.listGET /v1/audit_logsList the audit trail — who changed what, when, from which IP — of the workspace plus organization-level entries, newest first.
dashboards_audit_logs_getreadaudit.showGET /v1/audit_logs/:idFetch one audit entry by id, with its previous and new values, changes and request metadata.
dashboards_audit_logs_summaryreadaudit.exportGET /v1/audit_logs/summarySummarize 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.