Event data in webhooks

Webhooks are limited in the data they carry to remain as fast as possible. Webhook data is always contained in the JSON body of a webhook:

• storeId Ecwid store ID.

• eventCreated UNIX timestamp when the event happened.

• eventId Internal ID of the webhook event. Unique for each webhook.

• eventType Entity and action of the event defining what happened in the store. For example, the order.created event means that a new order was placed in the store.

• entityId: ID of the affected item, such as order ID, product ID, customer ID, etc. This ID allows you to request additional details about the entity with REST API immediately after receiving a webhook.

• data object: Additional details available to some events. For example, all order.created and order.updated webhooks always contain order payment and fulfillment statuses in addition to the order ID.

Webhook JSON examples

Order events:

New order in the store

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1234567,
  "storeId":1003,
  "entityId":103878161, // internal order ID. Use "orderId" instead
  "eventType":"order.created",
  "data":{
    "orderId":"XJ12H", // ID of created order
    "newPaymentStatus":"PAID",
    "newFulfillmentStatus":"SHIPPED"
  }
}

Order was updated

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1234567,
  "storeId":1003,
  "entityId":450012387, // internal order ID. Use "orderId" instead
  "eventType":"order.updated",
  "data":{
    "orderId":"B8HGD", // ID of updated order
    "oldPaymentStatus":"PAID",
    "newPaymentStatus":"PAID",
    "oldFulfillmentStatus":"PROCESSING",
    "newFulfillmentStatus":"SHIPPED"
  }
}

Order was deleted

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1234567,
  "storeId":1003,
  "entityId":103878161, //internal order ID. Use "orderId" instead
  "eventType":"order.deleted",
  "data":{
    "orderId":"XJ12H", // ID of deleted order
  }
}

Abandoned cart events:

New abandoned cart left in the store

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1634209655,
  "storeId": 1003,
  "entityId": 293225803, // internal order ID. Use "orderId" instead
  "eventType": "unfinished_order.created",
  "data": {
    "orderId": "RA1SD",
    "cartId": "320AB5DE-5EA6-4419-A4CF-0B04D2913190"
  }
}

Abandoned cart was updated

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1634209655,
  "storeId": 1003,
  "entityId": 293225803, // internal order ID. Use "orderId" instead
  "eventType": "unfinished_order.updated",
  "data": {
    "orderId": "RA1SD",
    "cartId": "320AB5DE-5EA6-4419-A4CF-0B04D2913190"
  }
}

Abandoned cart was deleted

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1634209655,
  "storeId": 1003,
  "entityId": 293225803, // internal order ID. Use "orderId" instead
  "eventType": "unfinished_order.deleted",
  "data": {
    "orderId": "RA1SD",
    "cartId": "320AB5DE-5EA6-4419-A4CF-0B04D2913190"
  }
}

Product events:

New product added to the store

{
  "eventId":"08a78904-4c1a-0aa0-953a-2e33c56236f1",
  "eventCreated":1469429915,
  "storeId":1003, 
  "entityId":667251253, // this is the id of the created product
  "eventType":"product.created"
}

Product was updated

{
  "eventId":"08a78904-0aa0-4c1a-953a-2e33c56236f0",
  "eventCreated":1469429912,
  "storeId":1003, 
  "entityId":66722483, // this is the id of the updated product
  "eventType":"product.updated"
}

Product was deleted

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1469429915,
  "storeId":1003, 
  "entityId":667251253, // this is the id of the deleted product
  "eventType":"product.deleted"
}

Category events:

New category added to the store

{
  "eventId":"08a78904-0aa0-4c1a-953a-2e33c56236f0",
  "eventCreated":1469429912,
  "storeId":1003, 
  "entityId":66722483, 
  "eventType":"category.created"
}

Category was updated

{
  "eventId":"08a78904-0aa0-4c1a-953a-2e123c236f0",
  "eventCreated":1469429912,
  "storeId":1003, 
  "entityId":66722483, 
  "eventType":"category.updated"
}

Category was deleted

{
  "eventId":"08a78904-0aa0-4c1a-953a-2e33c562336f0",
  "eventCreated":1469429912,
  "storeId":1003, 
  "entityId":66722483, 
  "eventType":"category.deleted"
}

Product review events:

New product review left in the store

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1634209655,
  "storeId": 1003,
  "entityId": 293225803, //internal review id
  "eventType": "review.created",
  "data":{
    "productId": 62752,
    "orderId": 63254,
    "status":"MODERATED",
  }
}

Product review was updated

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1634209655,
  "storeId": 1003,
  "entityId": 293225803, //internal review id
  "eventType": "review.updated",
  "data":{
    "productId": 62752,
    "orderId": 63254,
    "status":"PUBLISHED",
  }
}

Product review was deleted

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1634209655,
  "storeId": 1003,
  "entityId": 293225803, //internal review id
  "eventType": "review.deleted",
  "data":{
    "productId": 62752,
    "orderId": 63254,
  }
}

Customer events:

New customer added to the store

{
  "eventId": "80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated": 7891234567,
  "storeId": 1003,
  "entityId": 1663830, // customer ID
  "eventType": "customer.created",
  "data": {
    "customerEmail":"[e-mail]" // customer email
  }
}

Customer was updated

{
  "eventId": "80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated": 7891234567,
  "storeId": 1003,
  "entityId": 1663830, // customer ID
  "eventType": "customer.updated",
  "data": {
    "customerEmail":"[e-mail]" // customer email
  }
}

Customer was deleted

{
  "eventId": "80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated": 7891234567,
  "storeId": 1003,
  "entityId": 1663830, // customer ID
  "eventType": "customer.deleted",
  "data": {
    "customerEmail":"[e-mail]" // customer email
  }
}

Application events (can only be received by the same app):

App was installed to the store

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1234567,
  "storeId":1003,
  "entityId":"1003", // duplicates store ID
  "eventType":"application.installed"
}

App subscription was changed

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1234567,
  "storeId":1003,
  "entityId":"1003", // duplicates store ID
  "eventType":"application.subscriptionStatusChanged",
  "data":{
    "oldSubscriptionStatus":"TRIAL",
    "newSubscriptionStatus":"ACTIVE"
    }
}

App was uninstalled from the store

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1234567,
  "storeId":1003,
  "entityId":"1003", // duplicates store ID
  "eventType":"application.uninstalled"
}

Store profile events:

Store profile was updated

{
  "eventId": "80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated": 7891234567,
  "storeId": 1003,
  "entityId": 1003,
  "eventType": "profile.updated"
}

Store subscription was updated

{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1494503041,
  "storeId":1421002,
  "entityId":1421002, // duplicated store ID
  "eventType":"profile.subscriptionStatusChanged",
  "data":{
    "oldSubscriptionName":"ECWID_BUSINESS",
    "newSubscriptionName":"ECWID_UNLIMITED"
  }
}

Discount coupon events:

New discount coupon added to the store

{
  "eventId": "80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated": 7891234567,
  "storeId": 1003,
  "entityId": 12345678, // discount coupon ID
  "eventType": "discount_coupon.created",
}

Discount coupon was updated

{
  "eventId": "80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated": 7891234567,
  "storeId": 1003,
  "entityId": 12345678, // discount coupon ID
  "eventType": "discount_coupon.updated"
}

Discount coupon was deleted

{
  "eventId": "80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated": 7891234567,
  "storeId": 1003,
  "entityId": 12345678, // discount coupon ID
  "eventType": "discount_coupon.deleted"
}

Promotion (advanced discount) events:

New promotion added to the store

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1469429915,
  "storeId": 1003, 
  "entityId": 667251253, // Advanced discount ID 
  "eventType": "promotion.created",
  "data": {
    "version": 1 // Internal iterated version for tracking discount changes
  }
}

Promotion was updated

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1469429915,
  "storeId": 1003, 
  "entityId": 667251253, // Advanced discount ID 
  "eventType": "promotion.updated",
  "data": {
    "version": 1 // Internal iterated version for tracking discount changes
  }
}

Promotion was deleted

{
  "eventId": "95ed494f-362d-4fca-933d-f5c7064b04bb",
  "eventCreated": 1469429915,
  "storeId": 1003, 
  "entityId": 667251253, // Advanced discount ID 
  "eventType": "promotion.deleted",
  "data": {
    "version": 1 // Internal iterated version for tracking discount changes
  }
}

Invoice events:

New order tax invoice was created

{
  "eventId": "08a78904-4c1a-0aa0-953a-2e33c56236f1",
  "eventCreated": 1469429915,
  "storeId": 1003, 
  "entityId": 667251253, // Invoice ID 
  "eventType": "invoice.created",
  "data": {
    "orderId": "GH781" // order ID
  }
}

Order tax invoice was deleted

{
  "eventId": "08a78904-4c1a-0aa0-953a-2e33c56236f1",
  "eventCreated": 1469429915,
  "storeId": 1003, 
  "entityId": 667251253, // Invoice ID 
  "eventType": "invoice.deleted",
  "data": {
    "orderId": "GH781" // order ID
  }
}