Notificaciones (Webhooks)
Los Webhooks son notificaciones que se envían de un servidor a otro cuando ocurre un evento específico.
¿Cómo funciona?
1. Recibirás una notificación con los parámetros "id" y "tipo". Guarda esos datos y responde con un HTTP Status 200.
2. Solicita la información del recurso notificado y recibe los datos.
Para recibir las notificaciones sobre tus envíos, solo tienes que configurar la URL de notificaciones y seleccionar qué notificaciones deseas recibir desde tu panel de preferencias.
¿Que tipo de notificaciones se pueden recibir?
Actualmente puedes recibir notificaciones sobre:
| ID | Descripción |
|---|---|
| envio-procesado | Avisa que el envío ha sido procesado. |
| envio-cambio-condicion |
Avisa que la condición de un envio se ha modificado.
Esto permite que te enteres cuando el tracking de un envío se actualiza. |
¿Qué debo hacer al recibir una notificación?
Cuando recibas una notificación en tu plataforma, Envíopack espera una respuesta para validar que la recibiste correctamente. Para esto, debes devolver un HTTP STATUS 200 (OK) en un tiempo máximo de 5 segundos.
Para evitar superar ese tiempo, te sugerimos que no proceses la notificación apenas la recibes, sino que realices el procesamiento de la misma mediante un esquema de colas.
Envíopack va a intentar notificarte un máximo de 10 veces. De no obtener un HTTP STATUS 200 (OK) como respuesta seguiremos intentando cada 2 minutos hasta cumplir los 10 intentos.
Es importante aclarar que una vez recibido el HTTP STATUS 200 (OK) Envíopack asume que se recibió la notificaciones y no vuelve a realizar reintentos adicionales.
Ejemplos
Suponiendo que configuraste http://www.tudominio.com/notificaciones-enviopack como URL de notificaciones.
| ID | URL a notificar | Descripción |
|---|---|---|
| envio-procesado | http://www.tudominio.com/notificaciones-enviopack?tipo=envio-procesado&id=254 | El envío con ID 254 ha sido procesado correctamente. Para obtener el número de tracking asignado al envío solo tenes que hacer un GET /envios/254 |
| envio-cambio-condicion | http://www.tudominio.com/notificaciones-enviopack?tipo=envio-cambio-condicion&id=254 | El envío con ID 254 cambio su condición. Para enterarte el nuevo valor del campo condición solo tenes que hacer un GET /envios/254 |
Una vez que recibes la notificación solo tienes que obtener los parámetros tipo y id tal como recibes cualquier parámetro GET de tu aplicación.