Plataforma y datos
La identidad de la conexión, los indicadores de recuperación, importaciones y exportaciones, el registro de auditoría y los webhooks.
Familias en esta página
| Familia | Tools | read | write | destructive |
|---|---|---|---|---|
me — Identidad de la conexión | 1 | 1 | 0 | 0 |
metrics — Indicadores | 1 | 1 | 0 | 0 |
imports — Importaciones | 3 | 2 | 1 | 0 |
exports — Exportaciones | 5 | 4 | 1 | 0 |
audit_logs — Registro de auditoría | 1 | 1 | 0 | 0 |
webhook_endpoints — Webhooks | 9 | 3 | 2 | 4 |
Identidad de la conexión
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_me | read | cualquier token | GET /v1/me | Returns who owns the Bearer token sent. |
Indicadores
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_metrics_recovery | read | dashboard.view | GET /v1/metrics/recovery | Returns the period’s recovery metrics (default: last 6 months, counted from the first day of the starting month). |
Importaciones
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_imports_list | read | imports.list | GET /v1/imports | History of the organization’s 50 most recent imports (no pagination). |
dunning_imports_create | write | imports.create | POST /v1/imports | Uploads a CSV file of customers or charges and queues asynchronous processing. |
dunning_imports_get | read | imports.show | GET /v1/imports/{id} | Returns an import’s status with progress counters and per-row rejection errors (errors: [{ line, error }]; line 1 is the header, data starts at line 2). |
Exportaciones
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_exports_people | read | exports.create | GET /v1/exports/people | Generates and returns the customers CSV inline (text/csv; charset=utf-8 with BOM, Content-Disposition: attachment). |
dunning_exports_charges | read | exports.create | GET /v1/exports/charges | Generates and returns the charges CSV inline (text/csv; charset=utf-8 with BOM, Content-Disposition: attachment), with optional status and due-date filters. |
dunning_export_jobs_list | read | exports.create | GET /v1/exports/jobs | History of the organization’s 50 most recent asynchronous exports (no pagination). |
dunning_export_jobs_create | write | exports.create | POST /v1/exports/jobs | Schedules CSV generation on a worker, without the 10k-row cap of the synchronous mode and without blocking the request. |
dunning_export_jobs_download | read | exports.create | GET /v1/exports/jobs/{id}/download | Serves the generated CSV of an asynchronous export (text/csv; charset=utf-8 with BOM). |
Registro de auditoría
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_audit_logs_list | read | audit.list | GET /v1/audit-logs | Lists the organization’s audit trail records (newest first), with filters by action, entity, actor and period. |
Webhooks
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_webhook_endpoints_list | read | webhooks.list | GET /v1/webhook-endpoints | Lists the organization’s webhook endpoints with delivery counters by status. |
dunning_webhook_endpoints_create | write | webhooks.create | POST /v1/webhook-endpoints | Creates a webhook endpoint. |
dunning_webhook_endpoints_get | read | webhooks.show | GET /v1/webhook-endpoints/{id} | Returns the endpoint with its latest 20 deliveries. |
dunning_webhook_endpoints_update | write | webhooks.update | PATCH /v1/webhook-endpoints/{id} | Updates the endpoint (partial). |
dunning_webhook_endpoints_delete | destructive | webhooks.delete | DELETE /v1/webhook-endpoints/{id} | Soft-deletes the endpoint; pending deliveries stop being processed. |
dunning_webhook_endpoints_rotate_secret | destructive | webhooks.update | POST /v1/webhook-endpoints/{id}/rotate-secret | Generates a new HMAC secret; the previous one stops validating immediately. |
dunning_webhook_endpoints_test | destructive | webhooks.update | POST /v1/webhook-endpoints/{id}/test | Delivers a REAL webhook.test event to the endpoint through the same pipeline as business events (queue, HMAC signature, request/response capture, retry) — validate your consumer end to end without waiting for a real event. |
dunning_webhook_deliveries_list | read | webhooks.show | GET /v1/webhook-endpoints/{id}/deliveries | Lists the endpoint’s deliveries (paginated, newest first) with the request/response capture for inspection and debugging. |
dunning_webhook_deliveries_retry | destructive | webhooks.update | POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry | Re-queues a delivery for an immediate retry (status resets to pending). |
Los campos de cada recurso están en la Referencia de la API.
Una tool que no puedes ejecutar no aparece en tools/list. Si falta alguna de esta página, ve Autenticación.