Documentación de BizCortex

Webhooks

Avise automáticamente a otros sistemas cuando ocurran eventos, por ejemplo una nueva factura.

Un webhook envía una solicitud POST firmada a una URL de su elección cada vez que ocurre uno de los eventos seleccionados. Abra «Ajustes» y la pestaña «Webhooks». La tabla muestra la URL, los eventos, la última entrega con su hora y su código de respuesta, y el estado Activo o Inactivo.

Webhooks
Captura de pantalla de esta vista

Quién puede usarlo

  • Propietario
  • Administrador

Pasos

  1. 1. Añada un webhook

    Haga clic en «Añadir webhook». Introduzca la URL, marque al menos un evento, añada una descripción opcional y deje «Activo» activado. Guarde.

  2. 2. Entregue el secreto al receptor

    Abra el menú de la fila y elija «Mostrar secreto». Cada solicitud se firma con este secreto mediante HMAC SHA256. El sistema receptor comprueba la firma para asegurarse de que la solicitud procede de BizCortex.

  3. 3. Edite o pause

    Elija «Editar» para cambiar la URL, los eventos o la descripción. Desactive «Activo» para detener las entregas sin eliminar el webhook.

  4. 4. Rote el secreto

    Elija «Rotar secreto» si el secreto puede haberse filtrado. Actualice el sistema receptor con el nuevo secreto.

  5. 5. Elimine

    Elija «Eliminar» y confirme.

Campos y opciones

URL

Debe empezar por http:// o https://. Hasta 1000 caracteres.

Eventos

Elija entre: * (todos los eventos), sales.invoice.* (todos los eventos de facturas), sales.invoice.created, sales.invoice.posted, sales.invoice.cancelled, sales.payment.recorded, purchasing.bill.posted, accounting.transaction.posted y accounting.transaction.reversed.

Descripción

Nota opcional.

Activo

Solo los webhooks activos reciben eventos.

Consejos

  • Si la última entrega aparece en rojo, pase el ratón por encima para ver el error que devolvió el receptor.

Conviene saber

  • Cada solicitud contiene el nombre del evento, el id de su empresa y los datos del evento en formato JSON.
  • El receptor dispone de 10 segundos para responder. Si una entrega falla, BizCortex lo vuelve a intentar hasta 5 veces con pausas cada vez más largas (30 segundos y después 1, 2, 4 y 8 minutos).

Relacionado