Administradores

Webhooks

Con un webhook, bb-sign avisa a sus sistemas en el momento en que ocurre algo con un sobre: cuando se envía, cuando un firmante firma o cuando se completa. Cada aviso llega firmado, para que su sistema confirme que proviene de bb-sign. Esta página explica cómo configurarlo y supervisarlo; el código para verificar la firma está en Webhooks para desarrolladores.

Quién: administradores de la organización y administradores de plataforma. Dónde: Configuración, pestaña Webhooks.

Crear un webhook

Pulse Nuevo webhook.
Escriba la URL del endpoint. Debe usar HTTPS y ser accesible desde internet; bb-sign lo comprueba al crearlo y en cada entrega.
Marque los Eventos que quieres recibir, al menos uno.
Pulse Nuevo webhook. El diálogo Guarda este secreto de firma ahora muestra el Secreto de firma. Guárdelo en el gestor de secretos de su organización: se muestra una sola vez y su sistema lo necesita para verificar cada entrega.

Evento	Nombre en la aplicación	Cuándo se envía
`envelope.sent`	Sobre enviado	El sobre se envió a sus firmantes.
`envelope.completed`	Sobre completado	Todos los firmantes firmaron.
`envelope.cancelled`	Sobre cancelado	El sobre se canceló.
`envelope.expired`	Sobre caducado	El sobre venció sin completarse.
`signer.signed`	Firmante firmó	Un firmante firmó; puede haber otros pendientes.
`signer.viewed`	Firmante abrió el documento	Un firmante abrió el documento.

Su organización puede tener hasta 20 webhooks.

Probar un webhook

Enviar prueba entrega un evento de ejemplo, firmado como uno real, y muestra la respuesta de su endpoint. Úselo para confirmar la configuración antes de depender del webhook.

Activar y desactivar

Desactivar pausa los envíos sin borrar la configuración; Activar los reanuda. Los eventos que ocurren mientras el webhook está desactivado quedan en el historial como No enviado, y al reactivarlo bb-sign continúa con los eventos nuevos.

Rotar el secreto

Rotar secreto genera un secreto de firma nuevo sin interrumpir las entregas. Durante 24 horas, cada entrega lleva la firma del secreto anterior y la del nuevo, de modo que puede actualizar su sistema sin ventana de mantenimiento.

Eliminar un webhook

Eliminar detiene los envíos y borra el historial de entregas del webhook. La eliminación es definitiva.

Reintentos y desactivación automática

Si su endpoint no confirma una entrega con una respuesta 2xx, bb-sign la reintenta tras esperas de 1m, 5m, 30m, 2h, 12h, con una variación aleatoria de 20 %: unas 15 horas en total. El contenido de la entrega es el mismo en cada reintento.

Tras 3 entregas seguidas sin éxito después de todos sus reintentos, bb-sign desactiva el webhook para proteger su endpoint. La fila muestra Desactivado automáticamente y los administradores de la organización reciben un correo, en inglés, con el asunto «Action required: bb-sign disabled a webhook endpoint». bb-sign vuelve a probar el endpoint cada 6 horas y lo reactiva en cuanto responde correctamente.

Revisar el historial de entregas

Historial abre la lista de entregas del webhook. Cada fila muestra el estado, el evento, la fecha y el número de intentos. Al abrir una entrega verá cada intento con su resultado, el código de respuesta, la duración y, si hay un reintento programado, la hora del próximo intento.

Estado	Significado
Preparando	bb-sign está preparando la entrega.
Enviando	Hay un intento en curso o programado.
Entregado	Su endpoint confirmó la entrega.
Abandonado	Se completaron todos los reintentos sin confirmación. Revise su endpoint.
No enviado	El webhook estaba desactivado cuando ocurrió el evento.
No se pudo construir	Hubo un problema al preparar la entrega. Comuníquelo al soporte de Binary Bridges.

Resultado de un intento	Significado
Aceptado	Su endpoint respondió 2xx.
Rechazado	Su endpoint respondió con otro código, que aparece al lado.
Inaccesible	No hubo respuesta por un problema de DNS, de conexión o de tiempo de espera.

El historial se conserva 90 días. La creación, la rotación del secreto y la eliminación de cada webhook quedan en la auditoría.

Webhooks para desarrolladoresEl contenido de cada entrega, sus cabeceras y el código que verifica la firma en JavaScript y Java.