Webhook events
This article contains a complete reference of all Evance webhook events.
Understanding event strings
Event strings are comprised of a topic and an action (
{topic}/{action}
).
For example, product/created
indicates an event where a Product resource was
created.
Consistent event topics
Unlike API endpoints, which are typically plural, webhook event strings are typically singular. For example, an event string
of product/created
has a topic of
product
and an action of
created
.
Consistent event actions
Most event actions are consistent with the following rules:
{topic}/created
|
When data is inserted/created. |
{topic}/updated
|
When data is updated. |
{topic}/deleted
|
When data is soft deleted (if available) or hard deleted. |
{topic}/restored
|
When data is restored from a soft delete. |
Access Roles
Events associated with the Access Role object start with a role
topic.
role/* - Subscribe to all Access Role events. |
role/created
- Indicates that an Access Role was created. |
role/updated
- Indicates that an Access Role was updated.
|
role/deleted
- Indicates that an Access Role was deleted.
|
Geozones
Events associated with the Geozone object start with a geozone
topic.
geozone/*
- Subscribe to all Geozone events. |
geozone/created
- Indicates that a Geozone object was created. |
geozone/updated
- Indicates that a Geozone object was
updated.
|
geozone/deleted
- Indicates that an Geozone object was
deleted.
|
Inventory
Events associated with the Inventory object start with a inventory
topic.
inventory/*
- Subscribe to all Inventory events. |
inventory/created
- Indicates that an Inventory object was created. |
inventory/updated
- Indicates that an Inventory object was
updated.
|
inventory/deleted
- Indicates that an Inventory object was
deleted.
|
Product
Events associated with the Product object start with a product
topic.
product/*
- Subscribe to all Product events, including sub-objects such as Product Price (see below). |
product/created
- Indicates that a Product object was created. |
product/updated
- Indicates that a Product object
was updated.
|
product/deleted
- Indicates that a Product object was deleted.
|
product/restored
- Indicates that a Product object
was restored from a deleted state.
|
Product Download
Events associated with Product Download objects start with a
product/download
topic.
product/download/*
- Subscribe to all Product Download events. |
product/download/created
- Indicates that a Product Download object was created. |
product/download/updated
- Indicates that a Product Download object
was updated.
|
product/download/deleted
- Indicates that a Product Download object was deleted.
|
Product Media
Events associated with Product Media objects start with a
product/media
topic.
product/media/*
- Subscribe to all Product Media events. |
product/media/created
- Indicates that a Product Media object was created. |
product/media/updated
- Indicates that a Product Media object
was updated.
|
product/media/deleted
- Indicates that a Product Media object was deleted.
|
Product Price
Events associated with Product Price objects start with a
product/price
topic.
product/price/*
- Subscribe to all Product Price events. |
product/price/created
- Indicates that a Product Price object was created. |
product/price/updated
- Indicates that a Product Price object
was updated.
|
product/price/deleted
- Indicates that a Product Price object was deleted.
|
Product Specification
Events associated with Product Specification Entry objects start
with a product/specification
topic. These occur when a specification entry object
is modified for a product. To track changes to global Specifications see Specification and
Specification Value.
product/specification/*
- Subscribe to all Product Specification events. |
product/specification/created
- Indicates that a Product Specification object was
created.
|
product/specification/updated
- Indicates that a Product Specification object
was updated.
|
product/specification/deleted
- Indicates that a Product Specification object was
deleted.
|
Redirect rules
Events associated with Redirect objects start with a
redirect
topic.
redirect/*
- Subscribe to all Redirect events. |
redirect/created
- Indicates that a Redirect was created. |
redirect/updated
- Indicates that a Redirect
was updated.
|
redirect/deleted
- Indicates that a Redirect was deleted.
|
Specification
Events associated with global Specification header objects start with a specification
topic.
specification/*
- Subscribe to all Specification events. |
specification/created
- Indicates that a Specification object was
created.
|
specification/updated
- Indicates that a Specification object
was updated.
|
specification/deleted
- Indicates that a Specification object was
deleted.
|
Specification Value
Events associated with global Specification Value objects start
with a
specification/value
topic.
specification/value/*
- Subscribe to all Specification Value events. |
specification/value/created
- Indicates that a Specification Value object was
created.
|
specification/value/updated
- Indicates that a Specification Value object
was updated.
|
specification/value/deleted
- Indicates that a Specification Value object was
deleted.
|