webhooks

PATCH /api/v3/webhooks/{webhook_id}

Changed on

Update webhook configuration. You can update headers or/and status_rules.

webhook notification example:

{
  "headers": {
    "Content-Type": "application/json" // Change the headers
  },
  "status_rules": {
    "allowed_status_names": [
      "delivered"   // Change the allowed status names
    ]
  }
}

Catálogo de estados predeterminados

Los siguientes 15 estados se incluyen por defecto al registrar un webhook.

Para actualizar la suscripción, envía los valores de StatusName en status_rules.allowed_status_names. La lista enviada reemplaza la lista configurada actualmente. StatusCode se incluye como referencia del evento notificado y se envía como string; StatusName utiliza camelCase.

StatusCodeStatusName
2002onRoadToPickup
2003collected
2101unsuccessfulPickup
3001stored
3004onLinehaul
4001onRoadToDelivery
4002delivered
4101unsuccessfulDelivery
5001onRoadToReturn
5002returned
5101unsuccessfulReturn
8001stolen
8002lost
8003cancelled
8005invalidAddress

Request

  • Base URL
    https://delivery.99minutos.com
  • URL
    https://delivery.99minutos.com/api/v3/webhooks/{webhook_id}
  • Auth
    HTTP bearer

Request body

headersobject

Mapa de hasta 3 encabezados personalizados. Un mapa no vacío reemplaza los encabezados configurados.

Example request

{
  "status_rules": {
    "allowed_status_names": [
      "delivered",
      "unsuccessfulDelivery",
      "unsuccessfulReturn"
    ]
  }
}

Response

Config Response

statusinteger
messagestring

Changes