Saltar al contenido principal

Primeros pasos

En Auco, para darte control total de la integración con cada uno de los procesos creados, contamos con un sistema webhook en el que podrás recibir notificaciones en cada etapa de cada uno de los flujos creados, de inicio a fin.

Para configurar el webhook existen dos caminos, desde el API y la plataforma web:

Creación desde app.auco.ai:

Es importante que para realizar esta configuración seas admin o tengas permisos admin, desde la plataforma solo podrás crear un webhook, que será el webhook 'default'.

  • Ingresa con tu correo y contraseña.
  • Dirígete al perfil www.auco.ai/profile
  • ingresa a opciones de desarrollo
  • En la parte inferior encontrarás las opciones para modificar tu webhook y headers de autenticación si requieres.

Creación desde Auco API

¿Es posible tener varios webhooks?

🆕 Si! Desde el API es posible crear diferentes webhook, cada webhook debe tener un id, tu primer webhook debe tener el id 'default', que es donde por defecto se van a enviar todas las notificaciones; los siguientes webhooks pueden tener el id que prefieras.

important

Para definir a qué webhooks se notificarán los estados del proceso, en la creación del documento, debes guardar la lista de ids de los webhooks a los que se debe notificar.

Autenticación

Incluye tu llave privada en el encabezado Authorization.

Authorization: prk_xxx...

Parámetros de creación de webhooks

NombreTipoRequeridoDescripción
idStringRequeridoNombre identificador del webhook, el primer webhook debe ser default.
descriptionStringOpcionalDescripción del propósito del webhook.
urlStringRequeridoURL (URI válida) a la que se enviarán las notificaciones del webhook.
headerObjectOpcionalObjeto { key, value } con el header de autenticación a enviar.
header.keyStringCondicionalSubcampo de header. Requerido si se envía header: clave del header.
header.valueStringCondicionalSubcampo de header. Requerido si se envía header: valor del header.

¿Dónde se configuran?

Los webhooks se guardan mediante el endpoint Actualizar empresa (PUT /v1.5/ext/company), en el parámetro webhooks. Allí encontrarás los ejemplos completos de la petición en Curl, Python y Node.js.

👉 Ver Actualizar empresa.

Envía siempre la lista completa

El parámetro webhooks reemplaza la configuración existente: debes enviar la lista completa e incluir siempre el webhook con id: "default". Para conservar webhooks ya creados, inclúyelos en la petición.


⚠️ Respuestas de error

CódigoDescripción
400Falta el webhook default
401Autenticación inválida o ausente