Webhooks

Los webhooks son una funcionalidad que nuestra API ofrece para facilitar la comunicación automatizada entre nuestra plataforma y la API de tu sistema. Al configurar un webhook, especificas una URL de tu API como destino para recibir datos de manera automática cuando ocurren eventos específicos en nuestra plataforma, como la finalización de la emisión de un documento electrónico. Esta URL configurada dentro de tu API se utiliza para enviar notificaciones mediante solicitudes POST, permitiendo que tu sistema responda en tiempo real sin necesidad de consultas activas. Los webhooks están diseñados para integraciones directas y eficientes, optimizando el flujo de trabajo y la sincronización entre sistemas.

Cómo configurar un webhook

Para configurar un webhook, necesitas proporcionar dos cosas importantes:

• La URL de tu API que está preparada para recibir datos.
• Headers HTTP para asegurar que la comunicación entre nuestras plataformas sea segura.
  • Los headers HTTP son cruciales porque permiten:
    • Autenticar a la API de Alanube y evitar dejar tu url expuesta a todo el publico.
    • Enviar información especifica de una compañía.

Ejemplo de configuración de webhook

Si quieres recibir notificaciones cuando la emisión de un documento electrónico finaliza, tu configuración de webhook podría verse así al crear una compañía

{  
  "webhooks": {  
    "documents": {  
      "emissionFinished": {  
        "status": "active",  
        "url": "https://api.your-company.com/edocs",  
        "headers": {  
          "x-api-key": "api_key"  
        }  
      }  
    }  
  }  
}

En este ejemplo, "x-api-key": "api_key" es un header que autentica la solicitud a tu API, asegurando que la información sea procesada de manera segura y confiable. La URL específica facilita que solo tu sistema reciba y maneje los datos proporcionados por nuestra plataforma.