Skip to content

Obtener Webhook

Permite obtener la configuración completa de un webhook específico mediante su id.


Endpoint

GET
https://app.firmeasy.legal/api/v1/webhooks/{webhook_id}

Headers requeridos

Nombre Tipo Descripción Límites
Authorization * string Token de acceso obtenido en el login, con el prefijo 'Bearer'. Obligatorio
Content-Type string Especifica el tipo de contenido del cuerpo de la solicitud HTTP. Para las peticiones que incluyen datos JSON 'application/json'

Ejemplo de respuesta

{
"id": "b28f7c91-4d1e-48fb-87a1-62f4e913ad7d",
"user": "a56d3c72-917e-42e8-b38f-5e4c8d9b143a",
"document": null,
"event": "signer_rejected",
"target_url": "https://hooks.empresaglobal.com/events/b28f7c91-4d1e-48fb-87a1-62f4e913ad7d",
"active": true,
"secret_key": "7V4J3PQX1LND8E0YB5MC2KRF6H",
"custom_headers": null,
"signed_headers": null,
"type": "E",
"created_at": "2024-11-10T09:18:32.000000Z",
"updated_at": "2024-11-10T09:18:32.000000Z"
}

Campos devueltos

Nombre Tipo Descripción
id string Identificador único del webhook en Firmeasy.
user string ID del usuario propietario del webhook.
document string/null Documento asociado si aplica, o null.
event string Evento configurado que dispara el webhook.
target_url string URL destino configurada.
active boolean Indica si el webhook está activo.
secret_key string Clave secreta única que sirve para firmar los payloads con HMAC.
custom_headers array/null Cabeceras personalizadas si las tiene.
signed_headers array/null Headers firmados (por ahora null).
type string/null Tipo de webhook (uso reservado futuro).
created_at datetime Fecha de creación.
updated_at datetime Última actualización.