Configurar un webhook nuevo

Opciones de configuración

La configuración del webhook requiere que se definan cinco elementos:

• Nombre: se sugiere un nombre intuitivo que otros administradores puedan entender fácilmente.
• Ámbito: ¿qué anchura de red cubre el webhook? La cuenta y el grupo están disponibles en la interfaz.
  • La API es compatible con los ámbitos de Cuenta, Grupo, Usuario y Recursos.
  • Únicamente se puede definir un Ámbito por webhook.
• URL: la dirección URL de destino en la que Acrobat Sign ha insertado la carga de JSON.
• Eventos: el activador que hace que Acrobat Sign cree el JSON y lo inserte en la URL.
  • Cada evento crea una carga diferente relevante para el evento de activación.
  • Varios Eventos se pueden incluir en un webhook.
• Parámetros de notificación: los Parámetros de notificación identifican la carga del Evento JSON, lo que le permite seleccionar solo las secciones del Evento que son importantes para este webhook (y, por lo tanto, reducen los datos innecesarios en la URL).

Cuando el webhook esté completamente definido, haga clic en Guardar y el nuevo webhook empezará a reaccionar para activar los eventos inmediatamente. 

Ámbitos

• Cuenta: todos los eventos de suscripción que se producen en la cuenta activan la inserción.
  
  • Los administradores de cuentas tienen autoridad para ver todos los webhooks definidos para la cuenta y todos los grupos de esa cuenta.
• Grupo: todos los eventos suscritos que se producen en ese grupo activan la inserción. NOTA: los webhooks de ámbito de grupo solo existen para ese grupo.
  • Los administradores de grupo solo verán los webhooks dedicados a su grupo. No pueden ver los webhooks o webhooks de nivel de cuenta enlazados a otros grupos.
  • Las cuentas que tengan habilitadas los Usuarios en varios grupos verán la opción para establecer el grupo al que se debe aplicar el ámbito.
    
• Cuenta de usuario: todos los eventos de suscripción de una cuenta de usuario activan la inserción. Los webhooks de nivel de usuario solo se pueden crear mediante API.
• Webhook de nivel de recurso: se creará para un recurso específico. Los eventos específicos de este recurso se insertarán en la URL del webhook. Los webhooks de nivel de recurso solo se pueden crear mediante API.

URL

Una URL de webhook es un servidor que escucha los mensajes de notificación de POST HTTPS entrantes que se activan cuando se producen eventos.

Necesita esta dirección URL para suscribirse a su webhook para eventos.

• El cliente debe incluir una dirección URL HTTPS a la que Acrobat Sign pueda ser POST. Esta URL debe estar disponible en la red pública.  
  • Por ejemplo, los URI 127.0.0.1 y localhost no funcionarán.
  • El URL de punto final debe estar escuchando en el puerto 443 u 8443 (lo decide el cliente al definir la URL de devolución de llamada).
• Asegúrese de que el webhook admite solicitudes de POST para notificaciones de eventos entrantes y solicitudes de GET para la solicitud de verificación.
• Un cortafuegos no debe bloquear la URL.

Eventos

A continuación se muestran los eventos que pueden desencadenar una inclusión en la URL del webhook, agrupados por objeto y enumerados en el orden encontrado en la IU.

El valor de la izquierda es el valor que verá en la IU de Acrobat Sign. El valor de la derecha es el nombre del webhook en la API.

Para obtener información detallada sobre los webhooks y sus cargas, consulte la Guía para desarrolladores de Acrobat Sign.

Acuerdos:

Enviar en bloque:

Formularios web:

Plantillas de biblioteca (solo API):

Parámetros de notificación

Los parámetros de notificación permiten personalizar la carga de JSON a elementos específicos del evento.

Por ejemplo, en un evento Participante en el acuerdo sustituido, puede que solo desee la Información del acuerdo y la Información del participante, dejando fuera la Información del documento, y reduciendo el volumen total del JSON enviado en la URL del webhook.

• Acuerdo
  • Información del acuerdo: información detallada del acuerdo basada en el estado del acuerdo en el momento del evento desencadenante.
  • Información del documento del acuerdo: incluye cualquier información de documento generada como resultado del evento.
  • Información del participante del acuerdo: incluye la información de los participantes como resultado del evento.
  • Documento firmado del acuerdo: proporciona el PDF firmado. 
    • Aplicable al Flujo de trabajo del acuerdo completado y a todos los eventos del Acuerdo.
• Enviar en bloque
  
  • Información de Enviar en bloque: información detallada acerca el objeto Enviar en bloque que desencadenó el evento.
• Formulario web
  • Información del widget: información detallada acerca del formulario web que desencadenó el evento.
  • Información del documento del widget: la información del documento asociada a la plantilla del formulario web.
    
  • Información del participante del widget: información sobre los participantes definidos en la plantilla del formulario web.