Webhooks

Los webhooks, son actualizaciones que enviaremos a una URL de tu API para informarte de actualizaciones de tus envíos, creaciones y mucho más.

Suscribirse a los eventos de actualización

POST https://api.rocketfy.co/api/public/webhook/subscribe

This endpoint allows you to get free cakes.

Headers

Name	Type	Description
Authorization	string	Token que recibes del método de autenticación inicial en Primeros pasos y debe enviarse en el siguiente formato: Bearer MI_TOKEN_DE_ACCESO

Request Body

Name	Type	Description
event	string	Este parametro define el evento al que quieres subscribirte, la tabla de eventos está en la parte inferior luego de este método
url	string	Este parametro es la URL a la cual enviaremos las actualizaciones de tus envíos

200 Respuesta cuando te suscribes correctamente

{
    "event": "shippings.update",
    "url": "https://miapi.com/webhook/rocketfy",
    "created_date": 2021-06-28T14:31:17+05:00, //Fecha en ISO 8601
}

404 Rspuesta cuando no se encuentra el evento al que intentas suscribirte.

{ "message": "No se encontró el evento al que intentas suscribirte"}

Eventos a los cuales te puedes suscribir

Evento	Descripción
shippings.update	El evento se dispara cada vez que se actualiza el estado de un envío o información importante, y se enviará a la URL configurada cuando te suscribiste.
shippings.new	El evento se dispara cada vez que se crea un nuevo envío, y se enviará a la URL configurada cuando te suscribiste.
shippings.delete	El evento se dispara cada vez que se elimina un envío, y se enviará a la URL configurada cuando te suscribiste.