Webhooks — Evento ENVELOPE_SENT
assinar. Visão geral de todos os eventos em Webhooks.
Quando dispara
(
POST /v4/api/envelopes/{envelopeId}/send, ou criação a partir de modelo comsend: true).enviado de novo. Cada reenvio gera um novo
ENVELOPE_SENT.em
EXPIRED, ele volta a SENT e este evento é enviado.assinam com certificado ICP-Brasil, os documentos passam antes por uma
preparação. O
ENVELOPE_SENT sai quando essa preparação termina e o envelope defato começa a circular, e não no instante do pedido de envio.
Quando NÃO dispara
expirado): não há mudança de estado.
circulando.
Exemplo de payload
{
"id": "a7e1c2d3-0000-4000-8000-000000000010",
"event": "ENVELOPE_SENT",
"createdAt": "2026-09-13T13:00:02.000Z",
"data": {
"envelope": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "SENT",
"occurredAt": "2026-09-13T13:00:00.000Z"
},
"signatories": [
{
"id": "7a9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Pessoa Exemplo",
"email": "pessoa@example.com"
},
{
"id": "0b1c2d3e-4f50-4a61-8b72-93a4b5c6d7e8",
"name": "Diretoria",
"email": null
}
]
}
}Campos de data
| Campo | Tipo | Descrição |
|---|---|---|
envelope.id | string (UUID) | Id do envelope, o mesmo de GET /v4/api/envelopes/{envelopeId}. |
envelope.status | string | Status do envelope no momento em que a entrega foi montada. Normalmente SENT, mas pode já ter mudado (ex.: VOIDED se foi anulado logo em seguida). Use o event para saber o que aconteceu. |
envelope.occurredAt | string (ISO 8601, UTC) | Quando o envio aconteceu. |
signatories | array | Só os participantes com papel de signatário, na ordem de assinatura do envelope. Aprovadores e observadores não aparecem. |
signatories[].id | string (UUID) | Id do participante no envelope. |
signatories[].name | string ou null | Nome do participante (em um grupo, o nome do grupo). |
signatories[].email | string ou null | E-mail do participante, quando houver. |
id, event, createdAt, environment) e os cabeçalhosestão em Webhooks → Payload.
O que fazer com ele
ENVELOPE_EXPIRED como fim, voltar o envelope para"em andamento": o prazo foi estendido.
GET /v4/api/envelopes/{envelopeId} para ver os participantes e documentosatualizados.
Modificado em 2026-10-01 21:37:30