¿Qué es webhook?
Webhook es, junto a interfaz de programación API, un mecanismo que permite la comunicación entre servidores. Está diseñado principalmente para desarrolladores y usuarios avanzados.
¿Para qué sirve?
Los webhooks reducen la carga de la aplicación en el servidor, ya que la información necesaria es enviada automáticamente cuando ocurre un evento determinado, eliminando la necesidad de consultar la interfaz API para ver si han habido cambios. Las notificaciones de los eventos se recibe justo en el momento en el que ocurren, sin necesidad de consultar la aplicación con tanta frecuencia.
Puedes encontrar los webhooks en el sistema yendo a Ajustes > Ajustes de cuenta > Integración
Un Webhook tiene:
- Tipo - que determina cuándo se debe enviar el webhook (después de crear/actualizar/eliminar un cliente).
- URL - que es la dirección a la que se envía el webhook.
- API token - que es un token de autenticación que el usuario puede agregar al webhook y que será visible bajo la clave 'api_token'
El Webhook para POST enviado a la URL especificada. La estructura debe coincidir con los datos que se van a transmitir.
Para comunicar cambios relacionados con los clientes, enviar un POST adecuado, por ejemplo:
{
client_id: < único ID que representa al cliente en BitFactura>,
client: { <diccionario que representa al cliente en BitFactura> },
app_name: 'BitFactura',
api_token: <api_token introducido en webhook por usuario>,
locale: I18n.locale (por ejemplo 'es')
}