Tipos de eventos de webhook
Os 83 eventos que os webhooks entregam, agrupados pelo recurso que mudou. Todos partilham o mesmo envelope.
O envelope
Cada entrega é um POST com este corpo JSON, assinado com os cabeçalhos webhook-id, webhook-timestamp e webhook-signature (Standard Webhooks).
| Campo | Tipo | Significado |
|---|---|---|
id | string | Identificador do evento; o mesmo em todas as tentativas de entrega. |
type | string | O nome do evento, por exemplo invoice.issued. |
api_version | string | A versão da API em que o corpo é escrito. |
tenant_id | string | A empresa (espaço de trabalho) onde o evento aconteceu. |
created_at | string (RFC 3339) | Quando o evento foi registado. |
request_id | string | O pedido à API que causou a mudança, quando houve um; liga ao registo de pedidos. |
data.resource_type | string | O tipo do recurso que mudou. |
data.resource_id | string | O identificador desse recurso, para o ler na API. |
data.attributes | object | Campos próprios de cada evento; podem não existir. Leia o recurso na API para o estado completo. |
data.resource.sequence | integer | Conta os eventos do mesmo recurso; ignore um evento que não seja mais recente do que o último que aplicou. |
Exemplo de payload
{
"id": "wev_fHugZN3NJqbpAXWTkrw2CHiWT3A",
"type": "invoice.issued",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQYYcigzJZK54b",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQYYcigzJZK54b",
"sequence": 1
}
}
}Categorias
- Automationautomation.created, automation.deleted, automation.disabled5 eventos
- Billingbilling_run.executed, billing_schedule.created, billing_schedule.updated12 eventos
- Collectionscollection.case_settled, collection.cutoff_order_generated, collection.payment_plan_created5 eventos
- Connectionsconnection.application_created, connection.application_reviewed, connection.application_submitted10 eventos
- Customersaccount.created, account.link_rejected, account.linked7 eventos
- Developerwebhook.test1 eventos
- Metadatametadata.updated1 eventos
- Metersmeter.created, meter.exchanged, meter.installed10 eventos
- Notificationsnotification_preference.updated1 eventos
- Onboardingonboarding.approved, onboarding.information_requested, onboarding.rejected4 eventos
- Operationscrew.created, incident.reported, incident.resolved11 eventos
- Paymentsbank_statement.imported, cashier.shift_closed, cashier.shift_opened7 eventos
- Readingsreading.status_changed1 eventos
- Subscriptionplatform_invoice.issued, platform_invoice.paid, subscription.plan_changed3 eventos
- Supportticket.assigned, ticket.closed, ticket.commented5 eventos