Webhooks

Puedes crear webhooks ingresando a tu cuenta, o bien por hacerlo por API. Ante determinados eventos dispararemos estos webhooks para que puedas recibir en tu integración una notificación al instante.

Cada evento disparado consiste de un request POST a la URL que determines, con algunos datos sobre el recurso relacionado.

Es importante que tu servidor responda con un HTTP 200, de lo contrario nuestro sistema reintentará el envío de la notificación una vez por hora durante 12 horas.

Topics

Actualmente, los tópicos a los que te puedes suscribir son:

• status: Se dispara cuando hay un cambio de estado en un envío

• shipment: Se dispara cuando hay cualquier modificación en un envío

• account: Se dispara cuando hay una modificación en los datos o preferencias de una cuenta

• account_balance: Se dispara cuando hay un cambio en el saldo de la cuenta

• stock: Se dispara cuando hay un cambio en el stock de un SKU

Ejemplos del contenido de los Webhooks

status

{
   "topic":"status",
   "timestamp":"2024-03-08T18:56:34+00:00",
   "data":{
      "account_id":11600,
      "shipment_id":3850099,
      "external_id":"test-1709820269",
      "status":"Pendiente de preparacion",
      "status_code":"documentation_ready",
      "direction":"forward"
   }
}

shipment

{
   "topic":"shipment",
   "timestamp":"2024-03-08T18:56:34+00:00",
   "data":{
      "account_id":11600,
      "shipment_id":3850099,
      "external_id":"test-1709820269"
   }
}

Listar Webhooks

GET /v2/accounts/{account_id}/webhooks

Path Parameters

Name	Type	Description
account_id*	int	ID de la cuenta

200: OK

{
    "data": [
        {
            "id": 4,
            "account_id": 7,
            "topic": "status",
            "url": "https://website.com/api/zipnova/shipment/state/hook?client=13"
        }
    ],
    "links": {
        "first": "https://api.Zipnova.com.ar/v2/accounts/7/webhooks?page=1",
        "last": "https://api.Zipnova.com.ar/v2/accounts/7/webhooks?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://api.Zipnova.com.ar/v2/accounts/7/webhooks",
        "per_page": 20,
        "to": 1,
        "total": 1
    }
}

Suscribir a webhook

POST /v2/accounts/{account_id}/webhooks

Path Parameters

Name	Type	Description
account_id*	id	ID de la cuenta

Request Body

Name	Type	Description
topic*	string	Alguno de los códigos de topic indicados mas arriba.
url*	string	URL de destino del webhook

201: Created

{
    // Response
}

Actualizar URL

PUT /v2/accounts/{account_id}/webhooks/{id}

Path Parameters

Name	Type	Description
account_id*	int	ID de la cuenta
id*	int	ID del webhook

Request Body

Name	Type	Description
url*	string	Nueva URL de destino

200: OK

{
    // Response
}

Desuscribir de un webhook

DELETE /v2/accounts/{account_id}/webhooks/{id}

Path Parameters

Name	Type	Description
account_id*	int	ID de la cuenta
id*	int	ID del webhook

204: No Content

{
    // Response
}