Pular para o conteúdo principal

Webhooks, eventos e auditoria

Os endpoints que recebem os eventos da organização, as entregas e seus reenvios, o histórico de eventos e o log de auditoria.

Famílias nesta página​

FamíliaToolsreadwritedestructive
webhooks — Webhooks9324
webhook-deliveries — Entregas de webhook2200
events — Eventos2200
audit-logs — Auditoria3300

webhooks​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_webhooks_listreadreadwebhooks.listGET /v1/webhooksList the webhook endpoints of the workspace, newest first, each with its delivery_count.
dashboards_webhooks_getreadreadwebhooks.showGET /v1/webhooks/:idFetch one webhook endpoint by id: URL, subscribed events, auth type, active flag and delivery count.
dashboards_webhooks_createwrite · confirmaçãowritewebhooks.createPOST /v1/webhooksCreate an active webhook endpoint in the workspace subscribed to the given event types.
dashboards_webhooks_updatewrite · confirmaçãowritewebhooks.updatePATCH /v1/webhooks/:idUpdate a webhook endpoint — URL, description, subscribed events, active (pause/resume), or authentication (auth_type with its auth_config).
dashboards_webhooks_deletedestructivedeletewebhooks.deleteDELETE /v1/webhooks/:idDelete a webhook endpoint for good, together with its delivery log.
dashboards_webhooks_testdestructivewritewebhooks.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_secretdestructivewritewebhooks.updatePOST /v1/webhooks/:id/rotate_secretReplace the signing secret of a webhook endpoint.
dashboards_webhooks_deliveries_listreadreadwebhooks.showGET /v1/webhooks/:id/deliveriesList the delivery log of one webhook endpoint, newest first: status, HTTP status, attempts, request and response.
dashboards_webhooks_deliveries_retrydestructivewritewebhooks.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​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_webhook_deliveries_listreadreadwebhooks.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_getreadreadwebhooks.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​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_events_listreadreadevents.listGET /v1/eventsList the event log — the events webhooks are dispatched from — of the workspace plus organization-level events, newest first.
dashboards_events_getreadreadevents.showGET /v1/events/:idFetch one event by id, with its full payload (data) and metadata.

audit-logs​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_audit_logs_listreadreadaudit.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_getreadreadaudit.showGET /v1/audit_logs/:idFetch one audit entry by id, with its previous and new values, changes and request metadata.
dashboards_audit_logs_summaryreadreadaudit.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.

Os campos de cada recurso estão na Referência da API e em dashboards_schemas_get.

Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.