Skip to main content
GET
List your webhook events

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. Live and test keys are separate; the key you send decides which world the call acts in. To try calls, use a test key (it starts with lst_test_): no real courier is sent and no real money moves, but webhooks fire and the dropoff.phone you give can receive WhatsApp messages, so use your own number. A live key (it starts with lst_live_) books and charges real deliveries.

Query Parameters

type
enum<string>

Only events of one published type, such as delivery.status_changed. A value that is not a published type matches nothing. delivery.courier_location is left out of an unfiltered list and comes back only when you ask for it here.

Available options:
delivery.status_changed,
delivery.updated,
delivery.courier_location,
withdrawal.updated,
store.updated,
store.connected
delivery_id
string

Only the events about one delivery, by its dlv_ id. An id that is not one of your deliveries in this mode is 404 not_found.

created_after
string

Only events recorded at or after this instant (ISO-8601). A value that does not parse is 422 validation_failed with param: "created_after".

created_before
string

Only events recorded at or before this instant (ISO-8601). A value that does not parse is 422 validation_failed with param: "created_before".

cursor
string

The cursor of the previous page, to read the next one. Opaque: never build or parse one.

Response

200 - application/json

The request succeeded.

One page of events, newest first.

data
object[]
required

Every event your webhook endpoint receives, and every event the debugging reads return: one of the six below, told apart by type. data is the object the event is about, and its shape depends on type. See WebhookEventEnvelope for the fields they all share and for how delivery behaves (at-least-once, unordered).

has_more
boolean
required

True when a further page exists.

cursor
string | null
required

Pass as cursor to read the next page. Null on the last page.