Skip to content
ShopAssist Docs
APIAPI referenceEvent log

List Events

Events of the last 30 days (newest first).

GET/v1/eventsScope events:read

Events of the last 30 days (newest first).

Parameters

Parameters of List Events
NameInTypeDescription
typequerystring (enum) | null
store_idquerystring | null
created_afterquerystring | null
limitqueryintegerPage size
cursorquerystring | nullCursor from the previous page

Example request

curl -X GET "https://api.shopassist.coec.dk/v1/events" \
  -H "Authorization: Bearer $SHOPASSIST_API_KEY"

Response 200 (Page_WebhookEventEnvelope_)

Response of List Events
FieldTypeDescription
datarequiredWebhookEventEnvelope[]
data[].api_versionrequired"v1"default "v1"
data[].created_atrequiredstringformat date-time
data[].datarequiredobject
data[].idrequiredstringpattern `^evt_[0-9a-hjkmnp-tv-z]{26}$`
data[].organization_idrequiredstringpattern `^org_[0-9a-hjkmnp-tv-z]{26}$`
data[].store_idrequiredstring | nullnull for organization-level events (usage)pattern `^sto_[0-9a-hjkmnp-tv-z]{26}$`
data[].typerequiredstring (enum)one of conversation.created, conversation.closed, message.created, handoff.requested, handoff.updated, lead.captured, lead.confirmed, lead.unsubscribed, back_in_stock.subscribed, back_in_stock.notified, csat.submitted, action.executed, order.attributed, privacy_request.completed, store.status_changed, sync.failed, usage.threshold_reached
has_morerequiredboolean
next_cursorrequiredstring | nullOpaque cursor for the next page; null on the last page
{
  "data": [
    {
      "api_version": "v1",
      "created_at": "2026-09-28T10:15:30.123Z",
      "data": {},
      "id": "evt_01j8000000e008000000000000",
      "organization_id": "org_01j8000000e008000000000000",
      "store_id": "sto_01j8000000e008000000000000",
      "type": "conversation.created"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Errors

Every error uses the error envelope; the code field is stable.

  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 422 Unprocessable Content
  • 429 Too Many Requests

Last updated on