Webhooks (notificaciones)

Recibi notificaciones instantáneas (hooks) sobre cada evento de facturación, sin retrasos.

¿Qué es un WebHook?

Un webhook es una notificación que se envía de un servidor a otro, mediante una llamada HTTP POST al ocurrir un determinado evento.

TusFacturasAPP te enviará un webhook, siempre que se produzca uno o más eventos registrados en la modalidad de facturación asincrónica encolada, evitando pérdida de datos siempre que se presente alguna situación.

Dirección del webhook

La dirección del webhook se configura dentro de la información de tu punto de venta. Para eso deberás ingresar al MENÚ > Mi espacio de trabajo > Puntos de venta. Entra a editar tu punto de venta y al pie de la pantalla podrás indicar la dirección del webhook.

La dirección que establezcas para el webhook, no debe contener un redirect y debe encontrarse funcionando. Si la misma se encuentra fuera de servicio por más de 24hs será ignorada por completo y no se te notificará nada más, hasta que indiques una nueva URL.

El formato esperado es: https://www.dominio.com/script-nombre

¿Qué te notificaremos vía webhook?

Vas a recibir por POST un JSON, con la siguiente estructura, para que puedas relacionar mediante el external_reference que nos enviaste, al comprobante en cuestión, por tal motivo el external_reference que envíes, debe ser único.

JSON

{
	"creado": "18/03/2022 15:58:11",
	"evento": "encolado",
	"recurso": "facturacion",
	"external_reference": "17032",
	"intento": 1,
	"msg": [],
	"hook_id": "xxxxx"
} 

Headers

Verificá el hook recibido:

En los headers del request que te enviamos, podrás observar los siguientes headers:

User-Agent: TusFacturasAPP-webhook/1.0

TF-WebhookToken: TU_TOKEN_DEL_PDV

Tene en cuenta que algunos servidores pueden mostrarte el header todo en minúsculas, ej: tf-webhooktoken

Podrás obtener el TF-WebhookToken desde la grilla de puntos de venta, ingresando a Menú > Mi espacio de trabajo > CUITs/PDV.

Detalle de tipos de evento posibles por recurso

recurso	evento	info
facturacion	encolado	Éste evento te informa, que el comprobante que enviaste, se encuentra ya en la cola de procesamiento, para ser emitido en la fecha que indicaste.
facturacion	emitido	Éste evento te informa que el comprobante que enviaste, se ha facturado correctamente.
facturacion	error	Éste evento te informa que el comprobante que enviaste, no se ha podido procesar y recibrás dentro del atributo "msg", la lista con los errores detectados
facturacion	eliminado	Éste evento te informa que se ha eliminado un comprobante.
facturacion	cambio_fecha	Éste evento te informa que se ha cambiado la fecha del comprobante.
test	test	Se utilizará éste evento para probar la url de tu webhook

Reintentos

Cuando recibís una notificación en tu plataforma, TusFacturasAPP espera una respuesta para validar que la recibiste correctamente. Para eso, debes devolver un HTTP STATUS 200 (OK). Si no se envía esta respuesta, se entenderá que no ha recibido la notificación y se realizará un nuevo intento de envío hasta que reciba la respuesta.

Evento	Plazo después del último envío	Tiempo de espera de tu confirmación
Envío	-	20 segundos
Primer intento	5 minutos	5 segundos
Segundo intento	30 minutos	5 segundos
Tercer intento	3 horas	5 segundos
Cuarto intento	6 horas	5 segundos
Quinto intento	12 horas	5 segundos

Ejemplo de reintentos

Hook 0 _____________ enviado el 22/03/2022 a las 10:00

Hook 1 _____________ será enviado el 22/03/2022 a las 10:05

Hook 2 _____________ será enviado el 22/03/2022 a las 10:35

Hook 3 _____________ será enviado el 22/03/2022 a las 13:35

Hook 4 _____________ será enviado el 22/03/2022 a las 19:35

Hook 5 _____________ será enviado el 23/03/2022 a las 07:35

Una vez que recibo el webhook, ¿Qué hago?

Una vez recibido el webhook, deberás realizar una consulta avanzada a TusFacturasAPP para obtener los datos generados de ese comprobante.

A continuación te mostramos, la documentación asociada al recurso del que recibís el webhook.

Recurso	Documentación
facturacion	consulta avanzada por external_reference

Herramientas útiles

Webhook.site o Pipedream.com son herramientas útiles para probar webhooks rápidamente, ver cómo funcionan e inspeccionar lo que se envía, sin necesidad de codificar.

Consulta los hooks desde TusFacturasAPP

Ingresando a "Menú"> "API Request" > Hooks podrás consultar los hooks que te enviamos de una determinada external reference en los últimos 3 días.

FAQs

¿Dónde configuro mi webhook?

La dirección del webhook, se configura dentro de tu Punto de venta. Para eso deberás ingresar al MENÚ > Mi espacio de trabajo > Puntos de venta y editando el registro de tu punto de venta, podrás agregarlo. Tené en cuenta que la dirección del hook, debe ser válida.

En caso de que la dirección de mi webhook, presente inconvenientes y falle el webhook, ¿se realizan reintentos hasta completar la notificación?

Si. Te sugerimos consultar el apartado de "reintentos", de ésta misma página.

Si envío un lote de comprobantes, ¿Cómo recibo los hooks?

Siempre vas a recibir los hooks independientes por cada comprobante.

Preguntas Frecuentes

Consulta las preguntas frecuentes sobre las ventas asincrónicas.

¿Aún te quedan dudas? ¡Contactános!

En caso que requieras asistencia o tengas alguna duda relacionada con tu plan API DEV, envíanos un mensaje a [email protected] o contactanos por el chat que tenemos disponible en la web www.tusfacturas.app.