Webhooks & auditoria
Webhooks e logs de auditoria — reaja a eventos e rastreie mudanças.
Esta referência é gerada a partir do esquema da API. As descrições dos campos e qualquer texto ainda não traduzido são apresentados em inglês.
Webhook
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| POST | /internal/signatures/send-email | Signature email relay |
| POST | /internal/signatures/webhook | Signature middleware webhook |
| GET | /webhooks | Recupera a coleção de recursos Webhook. |
| POST | /webhooks | Cria um recurso Webhook. |
| GET | /webhooks/{id} | Recupera um recurso Webhook. |
| PATCH | /webhooks/{id} | Atualiza o recurso Webhook. |
| DELETE | /webhooks/{id} | Remove o recurso Webhook. |
| POST | /webhooks/e_invoice/incoming_cost | Incoming cost invoice webhook |
| POST | /webhooks/e_invoice/status | Cria um recurso Webhook. |
| POST | /webhooks/stripe | Cria um recurso Webhook. |
Campos de schema
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | |
| url | string | |
| active | boolean | |
| events | array | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) |
Log de Auditoria
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /audit-logs | Recupera a coleção de recursos AuditLog. |
| GET | /audit-logs/{id} | Recupera um recurso AuditLog. |
Campos de schema
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | |
| action | string | |
| executorEmployee | mixed | |
| relatedEmployee | mixed | |
| relationId | string | |
| relationName | string | |
| metadata | array | |
| details | stringnull | |
| createdAt | string (date-time) |
Registo de Webhook
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /webhook-logs | Recupera a coleção de recursos WebhookLog. |
| GET | /webhook-logs/{id} | Recupera um recurso WebhookLog. |
Campos de schema
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | |
| url | string | |
| event | string | |
| statusCode | integernull | |
| responseTime | integer | |
| response | string |