Skip to main content
All webhook events share the same structure. Following is an example JSON event: 
{
  "testMode": false,
  "id": "weve_geAva6c1RAuyb9HQxbSlmA",
  "webhookId": "wcon_P-VkRfmJTBaC6_Tst22cew",
  "shopId": "sh_7ad0c438-beda-4779-a885-0dc325a755c1",
  "type": "ORDER_PLACED",
  "apiVersion": "V1_BETA",
  "createdAt": "2023-07-12T15:05:11.078089+00:00",
  "data": {
    // Event-specific data
  }
}

​
Fields Description

FieldDescription
testModeIf true, indicates the event contains only test data. See Testing for more info.
idUnique identifier of the event. If you receive multiple events with the same id, treat them as duplicates.
webhookIdIndicates which webhook configuration was used.
shopIdYour shop ID, useful if you manage multiple shops under the same webhook endpoint.
typeIndicates which data type you should expect within the event.
apiVersionVersion of the data type that was chosen.
createdAtDate at which the event was created.
dataContains all the actual data specific to the type of the event.