Saltar al contenido principal

Configurar Webhooks

Para configurar un webhook en la plataforma, sigue estos pasos:

  1. Ingresa a la plataforma.
  2. Ve a la sección Integraciones.
  3. Selecciona la opción Webhooks.
  4. Haz clic en el botón Nuevo Webhook.

Pasos para crear un Webhook​

  1. Selecciona el Tipo de Webhook según la información que quieras recibir (ver Tipos de Webhook).
  2. Ingresa una Descripción que identifique claramente el propósito del webhook.
  3. Ingresa la URL donde se enviará la información.
  4. Agrega los Headers necesarios para la autenticación y otros parámetros.
  5. Define el estado del webhook: Activo o Inactivo.
  6. Haz clic en Guardar para finalizar la configuración.

Una vez configurado, podrás usar el webhook para recibir la información que solicites.

Tipos de Webhook​

Configura un webhook activo del tipo correspondiente antes de invocar la operación por API. De lo contrario, la solicitud responde 400 porque tu cuenta no tiene un webhook activo de ese tipo.

Tipo de WebhookQué entregaDocumentación
ResumenResumen de un RUT solicitado por API (JSON o PDF).Buscar Rut
Carga PerfilResultado de la búsqueda de compliance por nombre de un perfil cargado por API, con su análisis Marshal opcional.Cargar perfil en Compliance
Body de las entregas del webhook Resumen

El body que recibes depende de la versión de la API con la que solicitaste el resumen. Si lo solicitas por /api/clients/v3/webhook/profile/resumen, la entrega incluye el campo success, el bloque legal, ayudanteFallido y ayudantesFallidos con códigos numéricos. Si recibes entregas de distintas versiones en la misma URL, puedes distinguirlas por la presencia de success. Si lo solicitas con includeMarshal, la entrega puede demorar hasta 15 minutos mientras se completa el análisis Marshal.

Body de las entregas del webhook Carga Perfil

Las entregas de este webhook viajan como JSON comprimido con gzip (Content-Encoding: gzip), por lo que tu servidor debe poder descomprimirlas. Si lo solicitas con includeMarshal, la entrega puede demorar hasta 15 minutos mientras se completa el análisis Marshal.