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)
      • Evento ENVELOPE_SENT
      • Evento SIGNATORY_SIGNED
      • Evento ENVELOPE_COMPLETED
      • Evento ENVELOPE_VOIDED
      • Evento ENVELOPE_EXPIRED
      • Segurança e verificação
      • Entregas, retentativas e reenvio
      • Testar na Sandbox e automatizar
      • Introdução à documentação
      • Posicionar campos por texto âncora
      • Verificar um documento selado
      • Evento PARTICIPANT_DECLINED
      • Evento EMAIL_BOUNCED
    • 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
        • Listar envelopes
        • Criar rascunho de envelope
        • 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
        • Enviar lembrete ao participante
        • Sincronizar participantes
      • 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
        • Consultar o tamanho das páginas
        • Achar texto (âncora) no documento
        • Verificar um documento selado
        • Gerar URL de download do documento
        • Adicionar documento ao envelope
      • Contatos
        • Atualizar contato parcialmente
        • Listar envelopes do contato
        • Listar listas de contatos
        • Consultar lista de contatos
        • Criar contato
        • Atualizar contato
        • Listar contatos
        • Consultar 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
        • Listar webhooks
        • Atualizar webhook
        • Criar 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
        • Achar texto (âncora) no documento 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

Evento EMAIL_BOUNCED

Um e-mail enviado pela SuperSign a um participante não foi entregue: o
servidor de destino recusou, desistiu de entregar ou o endereço está suprimido.
Visão geral de todos os eventos em Webhooks.
Este evento é opcional: só chega ao endpoint que incluir EMAIL_BOUNCED no
campo events. Endpoints já cadastrados não passam a recebê-lo sozinhos.
Ele não muda o status do envelope: o envelope continua circulando. É um
aviso para você corrigir o contato (por exemplo, editar o e-mail do participante
e reenviar) antes que o prazo vença.

Quando dispara#

Quando qualquer e-mail enviado ao participante volta como não entregue:
convite, lembrete, código de verificação (OTP) e demais avisos ao
participante - não só o convite.
Inclui falha definitiva (HARD) e temporária (SOFT, quando o
provedor de e-mail desiste de entregar).
Dentro de um mesmo ciclo de envio, o evento só se repete se a falha
piorar: SOFT/OTHER contam como temporárias, HARD/SUPPRESSED como
definitivas. Assim, SOFT no convite seguido de HARD no lembrete gera
dois eventos (o segundo avisa que virou definitivo); HARD seguido de
SOFT, ou SOFT seguido de SOFT, gera um só. Depois de um
reenvio ao participante, abre-se um ciclo novo e um novo bounce gera um
novo evento.

Quando NÃO dispara#

E-mail enviado pelo SMTP próprio da sua conta (domínio próprio
configurado em Configurações): a entrega é do seu servidor e a SuperSign não
recebe o retorno de não entrega.
Resposta automática (ex.: fora do escritório) e outros avisos informativos:
a mensagem chegou.
Reclamação de spam: a mensagem chegou e a pessoa a marcou como spam.
Bounce atrasado de um envio anterior ao último reenvio.
E-mails que não são dirigidos a um participante (ex.: avisos a usuários da
conta).
Mensagens por WhatsApp ou SMS.

Exemplo de payload#

{
  "id": "f1e2d3c4-0000-4000-8000-000000000040",
  "event": "EMAIL_BOUNCED",
  "createdAt": "2026-10-02T15:00:05.000Z",
  "data": {
    "envelope": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "participant": {
      "id": "7a9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Pessoa Exemplo",
      "email": "pessoa@example.com",
      "role": "SIGNATORY"
    },
    "channel": "EMAIL",
    "failureType": "HARD",
    "occurredAt": "2026-10-02T15:00:00.000Z"
  }
}

Campos de data#

CampoTipoDescrição
envelope.idstring (UUID)Id do envelope.
participant.idstring (UUID)Id do participante no envelope, o mesmo do GET da API.
participant.namestring ou nullNome do participante no momento do bounce.
participant.emailstring ou nullE-mail do participante no momento do bounce.
participant.rolestringSIGNATORY (signatário), APPROVER (aprovador) ou OBSERVER (observador).
channelstringSempre EMAIL.
failureTypestringTipo da falha, normalizado (tabela abaixo).
occurredAtstring (ISO 8601, UTC)Quando o provedor de e-mail registrou a não entrega.

failureType#

ValorSignificadoO que fazer
HARDO endereço não existe ou é inválido.Corrigir o e-mail do participante e reenviar.
SOFTFalha temporária (caixa cheia, servidor indisponível, erro de DNS) e o provedor desistiu.Conferir o endereço; reenviar mais tarde.
SUPPRESSEDO endereço está bloqueado para envio por falhas ou reclamações anteriores; a mensagem nem saiu.Usar outro e-mail ou outro canal.
OTHEROutra recusa (bloqueio por conteúdo, política do domínio, motivo não classificado).Conferir o endereço com o participante.
Novos valores de failureType podem ser adicionados no futuro; trate valor
desconhecido como OTHER.
O formato externo (id, event, createdAt, environment) e os cabeçalhos
estão em Webhooks → Payload.

O que fazer com ele#

Avisar quem criou o envelope de que o participante não recebeu o e-mail.
Para deduplicar, use data.participant.id + data.occurredAt: a mesma
falha entregue de novo (retentativa ou reenvio da entrega) tem o mesmo par.
O e-mail do participante é dado pessoal: não o registre em log sem
necessidade.
Modificado em 2026-10-02 23:15:04
Página anterior
Evento PARTICIPANT_DECLINED
Próxima página
Consultar a conta da integração
Built with