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

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{account_id}/webhooks

Obtiene la lista de suscripciones a webhooks para una cuenta.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

account_idintegerRequerido

ID de la cuenta

Parámetros de consulta

topicstringOpcional

Filtrar por tópico del webhook

Respuestas

200

Lista paginada de webhooks

application/json

linksobjectOpcional

metaobjectOpcional

403

Sin acceso a esta cuenta

404

Cuenta no encontrada

get

/accounts/{account_id}/webhooks

HTTPcURLJavaScriptPython

GET /v2/accounts/{account_id}/webhooks HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*

{
  "data": [
    {
      "id": 1,
      "account_id": 1,
      "topic": "shipment",
      "url": "text"
    }
  ],
  "links": {},
  "meta": {}
}

Suscribir a webhook

post

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{account_id}/webhooks

Suscribir a nuevo webhook para recibir notificaciones de eventos en una URL específica.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

account_idintegerRequerido

ID de la cuenta

Cuerpo

application/json

topicstring · enumRequerido

Tópico del evento a escuchar

Example: shipmentValores posibles:

urlstring · urlRequerido

URL destino del webhook

Example: https://mi-servidor.com/webhook

Respuestas

201

Webhook creado exitosamente

application/json

400

Datos inválidos o webhook duplicado

403

Sin acceso a esta cuenta

post

/accounts/{account_id}/webhooks

HTTPcURLJavaScriptPython

POST /v2/accounts/{account_id}/webhooks HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "topic": "shipment",
  "url": "https://mi-servidor.com/webhook"
}

{
  "id": 1,
  "account_id": 1,
  "topic": "shipment",
  "url": "text"
}

Actualizar suscripción a webhook

put

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{account_id}/webhooks/{id}

Actualiza la URL de una suscripción a webhook existente.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

account_idintegerRequerido

ID de la cuenta

idintegerRequerido

ID del webhook

Cuerpo

application/json

urlstring · urlRequerido

Nueva URL del webhook

Example: https://mi-servidor.com/nuevo-webhook

Respuestas

200

Webhook actualizado exitosamente

application/json

idintegerOpcional

account_idintegerOpcional

topicstring · enumOpcionalExample: shipmentValores posibles:

urlstring · urlOpcional

400

Datos inválidos o webhook duplicado

403

Sin acceso a esta cuenta

404

Webhook no encontrado

put

/accounts/{account_id}/webhooks/{id}

HTTPcURLJavaScriptPython

PUT /v2/accounts/{account_id}/webhooks/{id} HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "url": "https://mi-servidor.com/nuevo-webhook"
}

{
  "id": 1,
  "account_id": 1,
  "topic": "shipment",
  "url": "text"
}

Eliminar suscripción a webhook

delete

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{account_id}/webhooks/{id}

Elimina una suscripción a webhook y sus intentos fallidos.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

account_idintegerRequerido

ID de la cuenta

idintegerRequerido

ID del webhook

Respuestas

204

Webhook eliminado exitosamente

403

Sin acceso a esta cuenta

404

Webhook no encontrado

delete

/accounts/{account_id}/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /v2/accounts/{account_id}/webhooks/{id} HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*

Sin contenido