PT EN
Nesta página

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).

CampoTipoSignificado
idstringIdentificador do evento; o mesmo em todas as tentativas de entrega.
typestringO nome do evento, por exemplo invoice.issued.
api_versionstringA versão da API em que o corpo é escrito.
tenant_idstringA empresa (espaço de trabalho) onde o evento aconteceu.
created_atstring (RFC 3339)Quando o evento foi registado.
request_idstringO pedido à API que causou a mudança, quando houve um; liga ao registo de pedidos.
data.resource_typestringO tipo do recurso que mudou.
data.resource_idstringO identificador desse recurso, para o ler na API.
data.attributesobjectCampos próprios de cada evento; podem não existir. Leia o recurso na API para o estado completo.
data.resource.sequenceintegerConta 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