ZapSign API
Español
Español
  • Información General
  • Antes de empezar
  • Entornos de ZapSign
  • Solicitudes listas para usar
  • Autenticación
    • Token estático
    • Autenticación JWT
      • Obtener el access token
      • Actualizar access token
  • Tipos de Tokens
  • Versiones de la API
  • Políticas de Rate Limit
  • Alertas de Incidentes
  • Cómo Funciona el Pago
  • Códigos de estado
  • Cuenta
    • Información del Plan
    • Listar usuarios de la cuenta
    • Crear usuarios en la cuenta
    • Eliminar usuario de la cuenta
  • Documentos
    • Crear documento via Upload
    • OneClick - Clickwrap
      • Crear documento (OneClick)
    • Crear documento via Plantilla
    • Adicionar documento (sobre)
    • Adicionar documento extra via Plantilla
    • Detalle del documento
    • Listar documentos
    • Eliminar documento
    • Histórico de eventos
    • Posicionar firma (opcional)
    • Rechazar documentos
  • Firmantes
    • Detalles del firmante
    • Actualizar firmante
    • Adicionar firmante
    • Eliminar firmante
    • Firma en lote via API
    • Rechazar documentos por el usuario
  • Plantillas
    • Crear plantilla DOCX
      • Configurar formulario de plantilla
    • Listar plantillas
    • Actualizar plantilla
    • Eliminar plantilla
  • Aliados / Re-sellers
    • Actualizar estado de pago
    • Crear cuenta
  • Antecedentes
    • Introducción
    • Entendiendo el resultado
  • Crear un consulta (check)
    • Consulta de persona
    • Consulta de empresa
  • Consultar check
  • Detalle del check
  • Webhooks
    • ¿Cómo funcionan los webhooks?
    • Probar webhooks en ZapSign
    • Crear Webhook
    • Registro de Webhooks
    • Eventos
      • De documento
        • Doc creado
        • Doc eliminado
        • Firmante creado
      • De firmantes
        • Solicitud de firma enviada
        • Doc visualizado
        • Confirmación lectura
        • Doc firmado
        • Doc rechazado
        • Email bounce
        • Validación Fallida
      • De antecedentes
        • Consulta completada
    • Reprocesando documentos y webhooks
    • Eliminar Webhook
  • Widget
    • iFrame: ¿cómo funciona?
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks

Eventos

Entiende los eventos enviados por los webhooks

ZapSign envía diferentes tipos de eventos a través de sus webhooks, permitiéndote recibir notificaciones automáticas sobre acciones importantes relacionadas con tus documentos.

  • doc_created Este evento se envía cuando se crea un documento.

  • created_signer Este evento se envía cuando se adiciona un nuevo firmante a un documento en curso.

  • doc_deleted Notifica cuando un documento ha sido eliminado, ya sea desde la plataforma o a través de la API.

  • doc_signed Se activa cuando un firmante firma el documento. En el webhook se especifíca cuál firmante firmo el documento.

  • doc_refused Indica que un documento ha sido rechazado por el firmante.

  • email_bounce Notifica sobre fallos en la entrega de correos electrónicos.

  • signature_notification_sent Notifica cuando se envia el documento al firmante por correo o WhatsApp (parámetro send_automatic_email o send_automatic_whatsapp)

  • doc_viewed Notifica cuando el firmante visualizo el documento (abre el link de firma)

  • doc_read_confirmation Notifica cuando el firmante confirma la lectura del documento (botón Continuar después de visualizar el documento).

  • signer_authentication_failed Notifica cuando el firmante excedio la cantidad máxima de intentos para validar su identidad por medio de los métodos Reconocimiento facial y Validación de Identidad.

  • background_check_completed Notifica cuando una consulta de antecedentes ha finalizado.

¿Cómo diferenciar los eventos?

Cada webhook incluye el atributo event_type, que especifica el tipo de evento asociado. Este atributo te permitirá identificar fácilmente qué acción disparó el webhook. Por ejemplo:

"event_type": "doc_created"

En los próximos capítulos exploraremos en profundidad el contenido de cada evento, para que puedas aprovechar al máximo estas notificaciones automáticas. 🚀

PreviousRegistro de WebhooksNextDe documento

Last updated 12 days ago

Was this helpful?