SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Crie seu primeiro envelope no Sandbox
      • 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 cliente com OpenAPI
      • 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
      • Conceitos da API V4
      • Posicionar campos por texto âncora
      • Verificar um documento selado
      • Evento PARTICIPANT_DECLINED
      • Evento EMAIL_BOUNCED
      • Entrega do convite pela integração
      • Evento PARTICIPANT_VIEWED
      • Guia completo da API V4
      • Assinatura embutida (sob consulta)
      • Salvar os documentos assinados no seu Drive
    • 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
        • Consultar link de assinatura
        • 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
        • Consultar o tamanho das páginas
        • Achar texto (âncora) no documento
        • Verificar um documento selado
        • Baixar o PDF de exemplo
        • 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
        • Enviar um evento de teste para o webhook
        • Atualizar webhook
        • Criar webhook
        • Listar webhooks
      • 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
        • Relatório de consumo do plano
        • Relatório de recusas, anulações e prazos vencidos
        • 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 PARTICIPANT_VIEWED

O evento PARTICIPANT_VIEWED é publicado na primeira visualização confirmada do link de um participante, inclusive aprovador e observador. Ele não afirma que a pessoa assinou, aprovou ou leu o documento inteiro. Consulte o status do envelope ou aguarde os demais eventos para acompanhar a conclusão.
O endpoint recebe o evento somente se o incluiu em events e a flag de ambiente PARTICIPANT_VIEWED_WEBHOOK_ENABLED está ligada. Com ela desligada, a API recusa uma nova assinatura desse evento. A entrega é assíncrona e pode chegar repetida ou fora de ordem. Deduplicate pelo id do evento; o mesmo fato conserva esse ID nas retentativas. Se a gravação secundária da outbox falhar, a visualização continua registrada e o webhook pode não ser emitido; reconcilie pelo histórico do envelope quando precisar de confirmação completa.
{
  "id": "f1e2d3c4-0000-4000-8000-000000000032",
  "event": "PARTICIPANT_VIEWED",
  "createdAt": "2026-11-11T16:00:00.000Z",
  "data": {
    "envelope": { "id": "550e8400-e29b-41d4-a716-446655440000" },
    "participant": {
      "id": "7a9e6679-7425-40de-944b-e07fc1f90ae7",
      "role": "SIGNATORY",
      "status": "VIEWED"
    },
    "occurredAt": "2026-11-11T16:00:00.000Z"
  }
}
Na sandbox, o envelope externo inclui "environment": "sandbox". O payload não inclui token, URL de assinatura, IP, agente do navegador, nome ou e-mail. Para identificar a pessoa, use o participant.id retornado pela API. A assinatura HMAC, as retentativas e as regras de desativação do endpoint são as mesmas dos outros webhooks.
Modificado em 2026-11-15 14:09:47
Página anterior
Entrega do convite pela integração
Próxima página
Guia completo da API V4
Built with