Saltar al contenido principal
GET
Lista tus eventos de webhook

Autorizaciones

Authorization
string
header
requerido

Tu llave de API, enviada como Authorization: Bearer <key>. Las llaves reales y de prueba son distintas; la llave que envías decide en qué modo actúa la llamada. Para probar llamadas, usa una llave de prueba (empieza con lst_test_): no se envía ningún repartidor real y no se mueve dinero real, pero los webhooks se disparan y el dropoff.phone que des puede recibir mensajes de WhatsApp, así que usa tu propio número. Una llave real (empieza con lst_live_) reserva y cobra envíos reales.

Parámetros de consulta

type
enum<string>

Solo eventos de un tipo publicado, como delivery.status_changed. Un valor que no es un tipo publicado no coincide con nada. delivery.courier_location se omite de una lista sin filtro y solo aparece cuando lo pides aquí.

Opciones disponibles:
delivery.status_changed,
delivery.updated,
delivery.courier_location,
withdrawal.updated,
store.updated,
store.connected
delivery_id
string

Solo los eventos de un envío, por su id dlv_. Un id que no sea de tus envíos en este modo es 404 not_found.

created_after
string

Solo eventos registrados en este instante o después (ISO-8601). Un valor que no se puede interpretar es 422 validation_failed con param: "created_after".

created_before
string

Solo eventos registrados en este momento o antes (ISO-8601). Un valor que no se pueda interpretar es 422 validation_failed con param: "created_before".

cursor
string

El cursor de la página anterior, para leer la siguiente. Es opaco: nunca lo construyas ni lo analices.

Respuesta

200 - application/json

La solicitud fue exitosa.

Una página de eventos, del más reciente al más antiguo.

data
object[]
requerido

Cada evento que recibe tu endpoint de webhook, y cada evento que devuelven las lecturas de depuración: uno de los seis de abajo, distinguidos por type. data es el objeto al que se refiere el evento, y su forma depende de type. Consulta WebhookEventEnvelope para los campos que todos comparten y para saber cómo se comporta la entrega (al menos una vez, sin orden).

has_more
boolean
requerido

Verdadero cuando existe una página siguiente.

cursor
string | null
requerido

Pásalo como cursor para leer la siguiente página. Null en la última página.