Webhooks
La API cuenta con webhooks que pueden ser configurados de forma independiente para cada compañía. Dichos webhooks sirven para que puedas mantener tu sistema sincronizado o realices acciones especificas cuando suceda un evento en especifico.
Configuración
La configuración de los webhooks se realiza y se asocia directamente a una compañía. Dentro de la definición técnica de los siguientes endpoints encontrará el grupo de información webhooks. Este objeto contendrá la información del webhook o del listado de webhooks configurados de forma independiente para cada compañía.
Ejemplo:
Nota
El siguiente ejemplo aplica para configurar la confirmación del cambio de estado de habilitación de la compañía y el cambio de estado de emisión de una Factura Electrónica de Venta.
"webhooks": {
"general": {
"governmentStatusChanged": {
"headers": {
"x-api-key": "test-api-key"
},
"url": "https://my-webhook-test.com",
"status": "active"
}
},
"invoices": {
"emissionFinished": {
"headers": {
"x-api-key": "test-api-key"
},
"url": "https://my-webhook-test-fe.com",
"status": "active"
}
},
},
Funcionamiento
Cuando ocurra un evento dentro de la API que dispara un webhook, la API realiza una solicitud/request de tipo POST a la url configurada dentro del webhook con los headers que hayas configurado.
Puedes usar la configuración de headers para:
- Autenticar a la API de Alegra y evitar dejar tu url expuesta a todo publico.
- Enviar información especifica de una compañía.
Lista de documentos
Los documentos que tiene flujo de notificación vía webhook son:
- Factura electrónica (
Invoice
) - Nota crédito (
Credit note
) - Nota débito (
Debit note
) - Nomina electrónica (
Payrolls
) - Documento soporte (
Support document
) - Nota ajuste documento soporte (
Adjusment note support document
) - Documento equivalente (
Equivalent Document
) - Nota ajuste documento equivalente (
Adjusment note equivalent document
) - Eventos electrónicos (
Events
)
Updated 3 months ago