ByDomuDevelopers

envelope.sent

Documento enviado para assinar

Objeto · envelopeNa hora

Quando é emitido

Um documento foi enviado para assinatura. recipients traz até 5 signatários com seu status.

Na hora, quando acontece no ByDomu: pelo app, pela API, pela Noa, por uma automação ou uma integração. actor.kind diz quem foi: USER, NOA, SYSTEM, API, AUTOMATION ou INTEGRATION.

Assine com

  • envelope.sentSó este evento
  • envelope.*Todos os de Documento para assinar
  • *O catálogo inteiro

Campos que traz

caminhos para filtros e modelos
envelope.idIdentificador do documento
envelope.titleTítulo do documento
envelope.statusStatus da assinatura
envelope.dealIdOportunidade
envelope.contactIdContato
envelope.signerNameNome de quem assina
envelope.signerEmailE-mail de quem assina

Até 5 tentativas (0 s, 5 s, 30 s, 2 min e 10 min) em erro de rede, 429 ou 5xx. Responda 2xx em menos de 10 s.

{
  "event": "envelope.sent",
  "id": "5f3a0c1e-7d2b-4f7e-9a51-0b6c1d2e3f40",
  "type": "envelope.sent",
  "timestamp": "2026-09-22T14:30:00.000Z",
  "organizationId": "clx1org001",
  "actor": {
    "kind": "USER",
    "userId": "clx1usr001"
  },
  "data": {
    "envelope": {
      "id": "clx1env001",
      "title": "Promesa de compraventa · Apartamento Chapinero Alto",
      "status": "IN_PROGRESS",
      "dealId": "clx1deal001",
      "signerName": "Laura Restrepo",
      "signerEmail": "[email protected]",
      "recipients": [
        {
          "name": "Laura Restrepo",
          "email": "[email protected]",
          "status": "NOTIFIED"
        },
        {
          "name": "Jorge Salazar",
          "email": "[email protected]",
          "status": "PENDING"
        }
      ],
      "expiresAt": "2026-10-06T14:30:00.000Z",
      "completedAt": null,
      "createdAt": "2026-09-22T14:30:00.000Z"
    }
  }
}
Peça com seus dados de testeGET /v1/webhooks/sample/envelope.sent
Testar