BigCommerce · Schema

HistoryEvent

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
scope string Alias where the event occurred.
store_id string A numerical identifier that is unique to each store.
data object A lightweight description of the event that triggered the webhook. Will vary depending on the event registered.
hash string The payload data encoded in JSON format and then passed through SH1 encryption.
created_at integer UTC timestamp, in seconds, that the events was created.
producer string Will always follow the pattern stores/store_hash. This is the store that created the webhook.
View JSON Schema on GitHub

JSON Schema

bigcommerce-historyevent-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HistoryEvent",
  "title": "HistoryEvent",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "Alias where the event occurred."
    },
    "store_id": {
      "type": "string",
      "description": "A numerical identifier that is unique to each store."
    },
    "data": {
      "type": "object",
      "description": "A lightweight description of the event that triggered the webhook. Will vary depending on the event registered."
    },
    "hash": {
      "type": "string",
      "description": "The payload data encoded in JSON format and then passed through SH1 encryption."
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "UTC timestamp, in seconds, that the events was created."
    },
    "producer": {
      "type": "string",
      "description": "Will always follow the pattern stores/store_hash. This is the store that created the webhook."
    }
  }
}