SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Primeiro envelope em 5 minutos
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
      • Criar um envelope a partir de um modelo
      • Gerar um cliente (SDK)
      • Webhooks — Evento ENVELOPE_SENT
      • Webhooks — Evento SIGNATORY_SIGNED
      • Webhooks — Evento ENVELOPE_COMPLETED
      • Webhooks — Evento ENVELOPE_VOIDED
      • Webhooks — Evento ENVELOPE_EXPIRED
      • Webhooks — Segurança e verificação
      • Webhooks — Entregas, retentativas e reenvio
      • Webhooks — Testar na Sandbox e automatizar
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Listar chamadas da própria chave
        • Consultar consumo do ciclo
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar e enviar envelope numa chamada
        • Gerar URL de download do envelope em ZIP
        • Duplicar envelope
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Consultar envelope
        • Mover envelope para outra pasta
        • Anular envelope
      • Participantes
        • Listar participantes do envelope
        • Aprovar participante aprovador
        • Recusar como participante aprovador
        • Corrigir contato do participante
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Confirmar o PDF convertido de um DOCX
        • Validar um documento selado
        • Reordenar documentos do envelope
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Atualizar contato parcialmente
        • Listar envelopes do contato
        • Listar listas de contatos
        • Consultar lista de contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar grupos da conta
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Listar todas as pastas
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Listar entregas de um webhook
        • Detalhar uma entrega de webhook
        • Reenviar uma entrega de webhook
        • Girar o segredo de assinatura do webhook
        • Criar webhook
        • Listar webhooks
        • Atualizar webhook
      • Modelos
        • Listar modelos
        • Consultar modelo
        • Criar envelope a partir de modelo
        • Criar modelo em rascunho
        • Editar título e descrição do modelo
        • Consultar processamento do documento do modelo
        • Ativar modelo
        • Duplicar modelo
        • Enviar documentos do modelo
        • Definir vagas do modelo
        • Posicionar campos no documento do modelo
        • Apagar modelo em rascunho
        • Reordenar documentos do modelo
        • Remover documento do modelo
        • Definir cópias do modelo
      • Auditoria e relatórios
        • Listar envelopes anulados
        • Relatório de envelopes
        • Relatório de uso por grupo
      • Etiquetas
        • Aplicar etiqueta ao envelope
        • Remover etiqueta do envelope
        • Listar etiquetas da conta
  1. Introdução

Webhooks — Evento ENVELOPE_EXPIRED

O prazo do envelope venceu sem que ele tivesse sido concluído. Visão geral de
todos os eventos em Webhooks.

Quando dispara#

Quando o prazo de um envelope em circulação vence e ainda falta alguma
assinatura ou aprovação. A verificação de prazos é periódica, então o evento
pode chegar alguns minutos depois do horário exato do vencimento.

Quando NÃO dispara#

Envelope sem prazo definido.
Envelope que foi concluído ou anulado antes do vencimento.
Expirar não é o fim definitivo. Se o prazo de um envelope expirado for
estendido, ele volta a circular e chega um
ENVELOPE_SENT; depois disso ele ainda pode
chegar a ENVELOPE_COMPLETED.

Exemplo de payload#

{
  "id": "f0e1d2c3-0000-4000-8000-000000000030",
  "event": "ENVELOPE_EXPIRED",
  "createdAt": "2026-09-30T03:00:05.000Z",
  "data": {
    "envelope": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "EXPIRED",
      "occurredAt": "2026-09-30T03:00:01.000Z"
    },
    "signatories": [
      {
        "id": "7a9e6679-7425-40de-944b-e07fc1f90ae7",
        "name": "Pessoa Exemplo",
        "email": "pessoa@example.com"
      }
    ]
  }
}

Campos de data#

CampoTipoDescrição
envelope.idstring (UUID)Id do envelope.
envelope.statusstringStatus no momento em que a entrega foi montada — normalmente EXPIRED.
envelope.occurredAtstring (ISO 8601, UTC)Quando a expiração foi registrada.
signatoriesarraySó os participantes com papel de signatário, na ordem de assinatura do envelope.
signatories[].idstring (UUID)Id do participante no envelope.
signatories[].namestring ou nullNome do participante.
signatories[].emailstring ou nullE-mail do participante.
O formato externo (id, event, createdAt, environment) e os cabeçalhos
estão em Webhooks → Payload.

O que fazer com ele#

Marcar o processo como "prazo vencido" e avisar o responsável.
Para dar mais tempo, estender o prazo do envelope; ele volta a circular e você
recebe ENVELOPE_SENT. Não trate o envelope como encerrado de forma
irreversível.
Para consultar quem ainda não assinou, use GET /v4/api/envelopes/{envelopeId}.
Modificado em 2026-10-01 21:37:45
Página anterior
Webhooks — Evento ENVELOPE_VOIDED
Próxima página
Webhooks — Segurança e verificação
Built with