Crear Webhook

Cómo crear y configurar webhooks en ZapSign

En ZapSign, puedes configurar webhooks de dos maneras:

A través de la interfaz web.
Mediante el endpoint de la API.

Ambas opciones te permiten configurar notificaciones en tiempo real de manera eficiente y flexible para que tu sistema esté siempre sincronizado con eventos importantes.

Recordatorio: Un webhook se aplica a todos los documentos de tu cuenta. No es necesario crear múltiples webhooks; basta con configurarlo una vez y será válido para todos los documentos.

1. Crear webhooks mediante la interfaz web

Paso 1: En tu cuenta de ZapSign, ve a Ajustes > Integraciones > API ZapSign > Webhooks

Paso 2: Ingresa el endpoint (URL) de tu servidor que recibirá los datos del webhook. Este endpoint debe estar preparado para procesar solicitudes POST y manejar datos en formato JSON.

Paso 3: Selecciona los eventos que deseas monitorear. ZapSign permite elegir entre los siguientes:

Documento creado.
Documento firmado.
Documento rechazado.
Documento eliminado.
Fallo en la entrega de email (Email Bounce).

También puedes elegir la opción “Todos”, que incluye solo eventos relacionados con documentos (creados, firmados, rechazados y eliminados). Nota: Esta opción no incluye el evento “Email Bounce”, que debe configurarse por separado.

Paso 4: Haz clic en el botón “+” para confirmar la configuración.

2. Crear webhooks mediante la API

Si prefieres gestionar tus webhooks desde la API, sigue estos pasos:

Attention: The "All" option includes only document events (created, signed, deleted, and refused). It does not include the "Email bounce" event (for email delivery failures). For this event, you need to register it separately.

Create a webhook

POST https://api.zapsign.com.br/api/v1/user/company/webhook/

Headers

Nombre

Tipo

Descripción

Authorization*

string

API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Nombre

Tipo

Descripción

url*

string

La URL de tu endpoint, ejemplo: "https://api.tusitio.com/webhook-zapsign/".

type*

string

Tipos de eventos: "" (todos) | "doc_signed" | "doc_created" | "doc_deleted" | "email_bounce"

doc_token

string

Token del documento para asociarlo. Si defines esto, los webhooks solo se activarán para ese documento específico.

headers

Array<Header>

Encabezados personalizados para mayor seguridad (detalles abajo).

{
    "id": // Recibirás un ID en la respuesta//
}

Make sure your API TOKEN is correct.

3. Configurar encabezados (headers) para webhooks

Puedes añadir encabezados HTTP personalizados para garantizar mayor seguridad y optimizar la comunicación entre aplicaciones. Esto permite que tus solicitudes sean verificadas por autenticación adicional, ofreciendo un nivel extra de protección.

Webhook - JSON root: POST {{api_url}}/api/v1/user/company/webhook/header/

{
    "id": {{webhook_id}},
    "headers": [
        {
            "name": "Authorization",
            "value": "Bearer YOUR_AUTHENTICATION_TOKEN"
        }
    ]
}

Ejemplo de una solicitud en Postman

https://www.postman.com/zapsign/workspace/zapsign-workspace/request/27495556-3413e0f8-be2d-4161-9ffa-b449443dc68d?ctx=documentationwww.postman.com

PreviousProbar webhooks en ZapSign NextRegistro de Webhooks

Last updated 5 months ago

Was this helpful?