List shop events

Returns the event log for this shop (webhook delivery history, order events, etc).

GET/shops/{shop_id}/events

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

shop_idintegerrequired

Query parameters

topicstring

Filter by event topic (e.g. order.created). The plural spelling (orders.created) is accepted too, and a parent topic (order) matches everything below it.

pageinteger

default: 1

per_pageinteger

default: 20

Responses

200

Paginated event list

_embeddedobject

Show properties

itemsobject[]

Show properties

Array of object

sequenceinteger

typestring

topicstring

item_typestring

item_idinteger

item_namestring

scopestring

payloadobject

user_idinteger

user_namestring

app_namestring

created_onstring<date-time>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idpath*topicqueryFilter by event topic (e.g. `order.created`). The plural spelling (`orders.created`) is accepted too, and a parent topic (`order`) matches everything below it.pagequeryper_pagequery

Request

curl -s -H "Authorization: Bearer $BOLDER_TOKEN" \
  "https://api.onbolder.com/v2/shops/1/events"

curl -X GET 'https://api.onbolder.com/v2/shops/1/events' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/shops/1/events", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/shops/1/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_class": [
    "results",
    "events"
  ],
  "total_items": 42,
  "_embedded": {
    "items": [
      {
        "sequence": 1001,
        "type": "order",
        "topic": "order.created",
        "item_type": "Order",
        "item_id": 5001,
        "item_name": "ORD-5001",
        "scope": "shop",
        "payload": {},
        "created_on": "2024-06-15T09:45:00Z"
      }
    ]
  }
}