Thanks for being patient while we implement your feedback to improve the developer experience.

Get Events

GET /hooks/events

Request

Get a list of events that were sent but not successfully received. Events are stored for not less than one week.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • page in query - integer

    Page number.

  • limit in query - integer

    Items count per page.

  • created_at:max in query - string

    Maximum value for returned data.

  • created_at:min in query - string

    Minimum value for returned data.

example

curl --request get \ --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/hooks/events' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx' \ --data '{}'

Response

Successful operation.

Body

object | application/json
  • data
    array[object]

  • meta
    object

example

{ "data": [ { "scope": "string", "store_id": "string", "data": {}, "hash": "string", "created_at": 0, "producer": "string" } ], "meta": { "pagination": { "total": 0, "count": 0, "per_page": 0, "current_page": 0, "total_pages": 0, "links": { "previous": "string", "current": "string", "next": "string" } } } }