Event catalog
Current Enad event type catalog, base event envelope fields, payload schema references, and webhook implementation boundary.
- API
- Events
- Schema
- events-catalog
Start here when an integration needs exact Enad event_type strings, base event envelope fields, or payload schema references. The current catalog contains 142 event types across 60 domains and 121 payload schemas.
Webhook delivery still uses the webhook delivery shape described in Events latest. This catalog describes the event contract behind those deliveries and lists each event's generated payload schema reference. Use the schema IDs and generated field summaries here for payload-shape routing; keep implementation validators aligned with the owning JSON Schema contract.
Base event envelope
| Field | Type | Required | Meaning |
|---|---|---|---|
id | string | Yes | Unique identifier for this event |
correlation_id | string | Yes | Correlation ID for tracking related events |
created_at | string | Yes | Timestamp when the event was created |
event_type | string | Yes | Event type identifier in format domain.action (e.g., product.new) |
producer | string | Yes | Name of the service that produced this event |
app_id | string | Yes | Application ID associated with this event |
payload | - | Yes | Event payload - schema depends on event_type |
Domain summary
| Domain | Event types | Examples |
|---|---|---|
| ai_generated_content | 1 | ai_generated_content.created |
| app | 4 | app.created, app.deleted, app.settings_updated, app.updated |
| attribute | 2 | attribute.deleted, attribute.updated |
| attribute_relationship | 2 | attribute_relationship.created, attribute_relationship.removed |
| brand | 3 | brand.created, brand.deleted, brand.updated |
| bundle | 2 | bundle.delete, bundle.upsert |
| category | 3 | category.created, category.deleted, category.updated |
| category_order | 1 | category_order.updated |
| category_relationship | 2 | category_relationship.created, category_relationship.deleted |
| channel | 3 | channel.created, channel.deleted, channel.updated |
| channel_content | 2 | channel_content.deleted, channel_content.upserted |
| collection | 5 | collection.created, collection.deleted, collection.relationship_created, collection.relationship_removed, collection.updated |
| collection_order | 1 | collection_order.updated |
| custom_role | 2 | custom_role.deleted, custom_role.upserted |
| customer_group | 2 | customer_group.deleted, customer_group.upserted |
| customer_group_product_variant_price | 1 | customer_group_product_variant_price.upserted |
| dam_folder | 4 | dam_folder.deleted, dam_folder.shareable_link_deleted, dam_folder.shareable_link_updated, dam_folder.updated |
| enad_user | 2 | enad_user.delete, enad_user.upsert |
| feed | 2 | feed.deleted, feed.updated |
| files | 2 | files.deleted, files.updated |
| image | 5 | image.created, image.deleted, image.relationship_created, image.relationship_removed, image.updated |
| integration | 3 | integration.delete, integration.new, integration.update |
| inventory | 3 | inventory.deleted, inventory.revoked_from_online, inventory.updated |
| market | 2 | market.delete, market.update |
| market_inventories | 1 | market_inventories.update |
| order | 2 | order.deleted, order.updated |
| organisation | 3 | organisation.created, organisation.deleted, organisation.updated |
| organisation_address_user | 2 | organisation_address_user.delete, organisation_address_user.restriction |
| organisation_status | 1 | organisation_status.changed |
| organisation_user | 2 | organisation_user.added, organisation_user.deleted |
| product | 3 | product.deleted, product.new, product.updated |
| product_channel_status | 2 | product_channel_status.changed, product_channel_status.removed |
| product_inventory | 3 | product_inventory.delete, product_inventory.delta_update, product_inventory.update |
| product_relation | 2 | product_relation.deleted, product_relation.updated |
| product_relation_product | 1 | product_relation_product.deleted |
| product_status | 1 | product_status.changed |
| product_stock_config | 1 | product_stock_config.update |
| product_variant | 3 | product_variant.deleted, product_variant.new, product_variant.updated |
| product_variant_price | 1 | product_variant_price.updated |
| product_variant_single_price | 2 | product_variant_single_price.deleted, product_variant_single_price.updated |
| product_variant_status | 1 | product_variant_status.changed |
| redirect | 2 | redirect.created, redirect.deleted |
| reporting | 1 | reporting.created |
| store_group | 2 | store_group.deleted, store_group.updated |
| store_group_market | 2 | store_group_market.deleted, store_group_market.updated |
| sync | 1 | sync.created |
| tag | 4 | tag.deleted, tag.relationship_created, tag.relationship_removed, tag.updated |
| tag_order | 1 | tag_order.updated |
| tax_group | 2 | tax_group.deleted, tax_group.updated |
| tax_group_market | 2 | tax_group_market.deleted, tax_group_market.updated |
| team | 3 | team.created, team.deleted, team.updated |
| team_user | 2 | team_user.added, team_user.delete |
| token | 3 | token.created, token.deleted, token.updated |
| translation | 2 | translation.delete, translation.upsert |
| user | 8 | user.created, user.deleted, user.reset_password, user.set_password, user.status_updated, user.updated, ... |
| user_content | 2 | user_content.deleted, user_content.uploaded |
| variant_group | 2 | variant_group.deleted, variant_group.upsert |
| variant_group_channel_status | 2 | variant_group_channel_status.changed, variant_group_channel_status.removed |
| video | 5 | video.deleted, video.relationship_created, video.relationship_removed, video.uploaded, video.upserted |
| virtual_bundle | 6 | virtual_bundle.created, virtual_bundle.deleted, virtual_bundle.product_added, virtual_bundle.product_removed, virtual_bundle.product_updated, virtual_bundle.updated |
Payload schema summary
| Payload schema | Schema ID | Top-level fields | Required fields | Meaning |
|---|---|---|---|---|
| AI Generated Content | Schema ID | 3 | 3 | AI-generated content for various item types |
| App Settings | Schema ID | 5 | 5 | Application settings configuration |
| Image | Schema ID | 12 | 11 | Image metadata and configuration |
| Market | Schema ID | 9 | 7 | A market configuration |
| Organisation | Schema ID | 20 | 16 | Organisation/company information |
| Organisation User | Schema ID | 4 | 4 | User membership in an organisation |
| Product File | Schema ID | 7 | 7 | Product file metadata |
| RelationshipOrder | Schema ID | 2 | 1 | Ordering information for relationships |
| Reporting | Schema ID | 13 | 8 | Usage reporting metrics |
| Reset Password | Schema ID | 0 | 0 | Password reset request information |
| Token | Schema ID | 8 | 6 | API token information |
| Translation | Schema ID | 3 | 3 | A translation entry with locale and value |
| User | Schema ID | 19 | 12 | User account information |
| Verify Email | Schema ID | 0 | 0 | Email verification information |
| Video | Schema ID | 8 | 7 | Video metadata and configuration |
| App Payload | Schema ID | 9 | 7 | Payload for app.created and app.updated events |
| App Deleted Payload | Schema ID | 1 | 1 | Payload for app.deleted event |
| AttributeDeletedPayload | Schema ID | 1 | 1 | Payload for attribute deleted events |
| AttributeRelationshipCreatedPayload | Schema ID | 2 | 1 | Payload for attribute relationship created events |
| AttributeRelationshipDeletedPayload | Schema ID | 2 | 1 | Payload for attribute relationship removed events |
| AttributeUpdatedPayload | Schema ID | 2 | 1 | Payload for attribute updated events |
| BrandPayload | Schema ID | 13 | 4 | Payload for brand created/updated events |
| BrandDeletePayload | Schema ID | 4 | 2 | Payload for brand deleted events |
| Bundle Group Payload | Schema ID | 9 | 8 | Payload for bundle.upsert event |
| Bundle Group Delete Payload | Schema ID | 1 | 1 | Payload for bundle.delete event |
| Category Payload | Schema ID | 15 | 10 | Payload for category.created and category.updated events |
| Category Delete Payload | Schema ID | 2 | 1 | Payload for category.deleted event |
| Category Relationship Created Payload | Schema ID | 4 | 4 | Payload for category_relationship.created event |
| Category Relationship Deleted Payload | Schema ID | 2 | 2 | Payload for category_relationship.deleted event |
| ChannelContentDeleted | Schema ID | 6 | 6 | Payload for channel_content.deleted events. Emitted when channel-specific content is deleted. |
| ChannelContentUpserted | Schema ID | 9 | 9 | Payload for channel_content.upserted events. Emitted when channel-specific content is created or updated. |
| ChannelCreated | Schema ID | 7 | 5 | Payload for channel created events |
| ChannelDeleted | Schema ID | 4 | 3 | Payload for channel deleted events |
| ChannelUpdated | Schema ID | 7 | 5 | Payload for channel updated events |
| ProductChannelStatusChanged | Schema ID | 6 | 6 | Payload for product_channel_status.changed events. Emitted when a product is added to a channel or its channel status flips. |
| ProductChannelStatusRemoved | Schema ID | 5 | 5 | Payload for product_channel_status.removed events. Emitted when a product is removed from a channel. |
| VariantGroupChannelStatusChanged | Schema ID | 6 | 6 | Payload for variant_group_channel_status.changed events. Emitted when a variant group is added to a channel or its channel status flips. |
| VariantGroupChannelStatusRemoved | Schema ID | 5 | 5 | Payload for variant_group_channel_status.removed events. Emitted when a variant group is removed from a channel. |
| Collection Payload | Schema ID | 6 | 5 | Payload for collection.created and collection.updated events |
| Collection Delete Payload | Schema ID | 1 | 1 | Payload for collection.deleted event |
| Collection Relationship Payload | Schema ID | 3 | 3 | Payload for collection.relationship_created and collection.relationship_removed events |
| CustomRoleDeletedPayload | Schema ID | 3 | 3 | Payload for deleting custom role |
| CustomRoleUpsertedPayload | Schema ID | 4 | 4 | Payload for upserting custom role |
| CustomerGroupProductVariantPricesUpsertedPayload | Schema ID | 3 | 3 | Payload for customer group product variant prices upserted events |
| CustomerGroupDeletedPayload | Schema ID | 1 | 1 | Payload for deleting customer group |
| CustomerGroupUpsertedPayload | Schema ID | 6 | 4 | Payload for upserting customer group |
| DamFolderDeletedPayload | Schema ID | 1 | 1 | Payload for DAM folder deleted events |
| DamFolderUpdatedPayload | Schema ID | 7 | 5 | Payload for DAM folder updated events |
| DamFolderShareableLinkDeletedPayload | Schema ID | 1 | 1 | Payload for DAM folder shareable link deleted events |
| DamFolderShareableLinkUpdatedPayload | Schema ID | 9 | 7 | Payload for DAM folder shareable link updated events |
| Enad User Deleted Payload | Schema ID | 1 | 1 | Payload for enad_user.delete event |
| Enad User Upsert Payload | Schema ID | 7 | 3 | Payload for enad_user.upsert event |
| FeedDeletedPayload | Schema ID | 2 | 2 | Payload for feed deleted events |
| FeedUpdatePayload | Schema ID | 17 | 7 | Payload for feed updated events |
| Product File Deleted Payload | Schema ID | 1 | 1 | Payload for files.deleted event |
| Image Deleted Payload | Schema ID | 1 | 1 | Payload for image.deleted event |
| Image Relationship Payload | Schema ID | 3 | 3 | Payload for image.relationship_created and image.relationship_removed events |
| Integration Delete Payload | Schema ID | 1 | 1 | Payload for integration.delete event |
| Integration New Payload | Schema ID | 6 | 5 | Payload for integration.new event |
| Integration Update Payload | Schema ID | 6 | 5 | Payload for integration.update event |
| Inventory Deleted Payload | Schema ID | 2 | 1 | Payload for inventory.deleted event |
| Inventory Revoked From Online Payload | Schema ID | 1 | 1 | Payload for inventory.revoked_from_online event |
| Inventory Updated Payload | Schema ID | 6 | 4 | Payload for inventory.updated event |
| Market Inventories Update Payload | Schema ID | 3 | 3 | Payload for market_inventories.update event |
| Product Inventory Delete Payload | Schema ID | 6 | 5 | Payload for product_inventory.delete event |
| Product Inventory Delta Update Payload | Schema ID | 9 | 4 | Payload for product_inventory.delta_update event |
| Product Inventory Update Payload | Schema ID | 12 | 6 | Payload for product_inventory.update event |
| Product Stock Config Update Payload | Schema ID | 4 | 3 | Payload for product_stock_config.update event |
| MarketDeletedPayload | Schema ID | 1 | 1 | Payload for market deleted events |
| Order Payload | Schema ID | 25 | 25 | Payload for order.updated event |
| Order Deleted Payload | Schema ID | 1 | 1 | Payload for order.deleted event |
| Organisation Address User Restriction Added Payload | Schema ID | 3 | 3 | Payload for organisation_address_user.restriction event |
| Organisation Address User Restriction Deleted Payload | Schema ID | 3 | 3 | Payload for organisation_address_user.delete event |
| Organisation Deleted Payload | Schema ID | 2 | 1 | Payload for organisation.deleted event |
| Organisation Status Changed Payload | Schema ID | 4 | 3 | Payload for organisation_status.changed event |
| Product Relation Deleted Payload | Schema ID | 1 | 1 | Payload for product_relation.deleted event |
| Product Relation Product Detach Payload | Schema ID | 2 | 1 | Payload for product_relation_product.deleted event |
| Product Relation Updated Payload | Schema ID | 6 | 3 | Payload for product_relation.updated event |
| ProductVariantPricesUpdatedPayload | Schema ID | 6 | 6 | Payload for product variant prices updated events |
| ProductVariantSinglePriceDeletedPayload | Schema ID | 7 | 7 | Payload for single product variant price deleted events |
| ProductVariantSinglePriceUpdatedPayload | Schema ID | 7 | 7 | Payload for single product variant price updated events |
| Product Payload | Schema ID | 39 | 13 | Payload for product.new and product.updated events |
| Product Delete Payload | Schema ID | 2 | 2 | Payload for product.deleted event |
| Product Status Changed Payload | Schema ID | 5 | 5 | Payload for product_status.changed event |
| Product Variant Payload | Schema ID | 32 | 9 | Payload for product_variant.new and product_variant.updated events |
| Product Variant Delete Payload | Schema ID | 3 | 3 | Payload for product_variant.deleted event |
| Product Variant Status Changed Payload | Schema ID | 7 | 7 | Payload for product_variant_status.changed event |
| RedirectPayload | Schema ID | 6 | 5 | Payload for redirect created events |
| RedirectsDeletedPayload | Schema ID | 1 | 0 | Payload for redirect deleted events |
| StoreGroupDeletedPayload | Schema ID | 2 | 2 | Payload for store group deleted events |
| StoreGroupMarketDeletedPayload | Schema ID | 4 | 4 | Payload for store group market deleted events |
| StoreGroupMarketUpdatedPayload | Schema ID | 4 | 4 | Payload for store group market updated events |
| StoreGroupUpdatedPayload | Schema ID | 7 | 4 | Payload for store group updated events |
| SyncCreatedPayload | Schema ID | 2 | 2 | Payload for sync created events |
| TagDeletedPayload | Schema ID | 1 | 1 | Payload for tag deleted events |
| TagRelationshipPayload | Schema ID | 4 | 3 | Payload for tag relationship created/removed events |
| TagUpdatedPayload | Schema ID | 1 | 1 | Payload for tag updated events |
| Tax Group Deleted Payload | Schema ID | 2 | 2 | Payload for tax_group.deleted event |
| Tax Group Market Deleted Payload | Schema ID | 3 | 3 | Payload for tax_group_market.deleted event |
| Tax Group Market Updated Payload | Schema ID | 3 | 3 | Payload for tax_group_market.updated event |
| Tax Group Updated Payload | Schema ID | 4 | 4 | Payload for tax_group.updated event |
| Team Payload | Schema ID | 4 | 3 | Payload for team.created and team.updated events |
| Team Deleted Payload | Schema ID | 1 | 1 | Payload for team.deleted event |
| Team User Payload | Schema ID | 3 | 3 | Payload for team_user.added and team_user.delete events |
| TokenDeleted | Schema ID | 1 | 1 | Payload for token deleted events |
| Translation Delete Payload | Schema ID | 1 | 1 | Payload for translation.delete event |
| User Content Deleted Payload | Schema ID | 1 | 1 | Payload for user_content.deleted event |
| User Content Upload Payload | Schema ID | 7 | 6 | Payload for user_content.uploaded event |
| User Deleted Payload | Schema ID | 2 | 2 | Payload for user.deleted event |
| User Set Password Payload | Schema ID | 2 | 2 | Payload for user.set_password event |
| User Status Changed Payload | Schema ID | 3 | 3 | Payload for user.status_updated event |
| Variant Group Deleted Payload | Schema ID | 2 | 2 | Payload for deleted variant_groups |
| Variant Group Upsert Payload | Schema ID | 2 | 2 | Payload for Variant groups |
| Video Deleted Payload | Schema ID | 1 | 1 | Payload for video.deleted event |
| Video Relationship Payload | Schema ID | 2 | 2 | Payload for video.relationship_created and video.relationship_removed events |
| Video Uploaded Payload | Schema ID | 1 | 1 | Payload for video.uploaded event |
| Virtual Bundle Payload | Schema ID | 19 | 13 | Payload for virtual_bundle.created and virtual_bundle.updated events |
| Virtual Bundle Delete Payload | Schema ID | 2 | 2 | Payload for virtual_bundle.deleted event |
| Virtual Bundle product Added Payload | Schema ID | 2 | 2 | Payload for virtual_bundle.product_added event |
| Virtual Bundle product Removed Payload | Schema ID | 2 | 2 | Payload for virtual_bundle.product_removed event |
| Virtual Bundle product Updated Payload | Schema ID | 2 | 2 | Payload for virtual_bundle.product_updated event |
Event types
ai_generated_content
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
ai_generated_content.created | created | AI Generated Content |
app
Count: 4
| Event type | Action | Payload schema |
|---|---|---|
app.created | created | App Payload |
app.deleted | deleted | App Deleted Payload |
app.settings_updated | settings_updated | App Settings |
app.updated | updated | App Payload |
attribute
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
attribute.deleted | deleted | AttributeDeletedPayload |
attribute.updated | updated | AttributeUpdatedPayload |
attribute_relationship
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
attribute_relationship.created | created | AttributeRelationshipCreatedPayload |
attribute_relationship.removed | removed | AttributeRelationshipDeletedPayload |
brand
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
brand.created | created | BrandPayload |
brand.deleted | deleted | BrandDeletePayload |
brand.updated | updated | BrandPayload |
bundle
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
bundle.delete | delete | Bundle Group Delete Payload |
bundle.upsert | upsert | Bundle Group Payload |
category
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
category.created | created | Category Payload |
category.deleted | deleted | Category Delete Payload |
category.updated | updated | Category Payload |
category_order
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
category_order.updated | updated | RelationshipOrder |
category_relationship
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
category_relationship.created | created | Category Relationship Created Payload |
category_relationship.deleted | deleted | Category Relationship Deleted Payload |
channel
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
channel.created | created | ChannelCreated |
channel.deleted | deleted | ChannelDeleted |
channel.updated | updated | ChannelUpdated |
channel_content
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
channel_content.deleted | deleted | ChannelContentDeleted |
channel_content.upserted | upserted | ChannelContentUpserted |
collection
Count: 5
| Event type | Action | Payload schema |
|---|---|---|
collection.created | created | Collection Payload |
collection.deleted | deleted | Collection Delete Payload |
collection.relationship_created | relationship_created | Collection Relationship Payload |
collection.relationship_removed | relationship_removed | Collection Relationship Payload |
collection.updated | updated | Collection Payload |
collection_order
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
collection_order.updated | updated | RelationshipOrder |
custom_role
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
custom_role.deleted | deleted | CustomRoleDeletedPayload |
custom_role.upserted | upserted | CustomRoleUpsertedPayload |
customer_group
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
customer_group.deleted | deleted | CustomerGroupDeletedPayload |
customer_group.upserted | upserted | CustomerGroupUpsertedPayload |
customer_group_product_variant_price
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
customer_group_product_variant_price.upserted | upserted | CustomerGroupProductVariantPricesUpsertedPayload |
dam_folder
Count: 4
| Event type | Action | Payload schema |
|---|---|---|
dam_folder.deleted | deleted | DamFolderDeletedPayload |
dam_folder.shareable_link_deleted | shareable_link_deleted | DamFolderShareableLinkDeletedPayload |
dam_folder.shareable_link_updated | shareable_link_updated | DamFolderShareableLinkUpdatedPayload |
dam_folder.updated | updated | DamFolderUpdatedPayload |
enad_user
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
enad_user.delete | delete | Enad User Deleted Payload |
enad_user.upsert | upsert | Enad User Upsert Payload |
feed
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
feed.deleted | deleted | FeedDeletedPayload |
feed.updated | updated | FeedUpdatePayload |
files
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
files.deleted | deleted | Product File Deleted Payload |
files.updated | updated | Product File |
image
Count: 5
| Event type | Action | Payload schema |
|---|---|---|
image.created | created | Image |
image.deleted | deleted | Image Deleted Payload |
image.relationship_created | relationship_created | Image Relationship Payload |
image.relationship_removed | relationship_removed | Image Relationship Payload |
image.updated | updated | Image |
integration
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
integration.delete | delete | Integration Delete Payload |
integration.new | new | Integration New Payload |
integration.update | update | Integration Update Payload |
inventory
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
inventory.deleted | deleted | Inventory Deleted Payload |
inventory.revoked_from_online | revoked_from_online | Inventory Revoked From Online Payload |
inventory.updated | updated | Inventory Updated Payload |
market
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
market.delete | delete | MarketDeletedPayload |
market.update | update | Market |
market_inventories
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
market_inventories.update | update | Market Inventories Update Payload |
order
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
order.deleted | deleted | Order Deleted Payload |
order.updated | updated | Order Payload |
organisation
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
organisation.created | created | Organisation |
organisation.deleted | deleted | Organisation Deleted Payload |
organisation.updated | updated | Organisation |
organisation_address_user
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
organisation_address_user.delete | delete | Organisation Address User Restriction Deleted Payload |
organisation_address_user.restriction | restriction | Organisation Address User Restriction Added Payload |
organisation_status
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
organisation_status.changed | changed | Organisation Status Changed Payload |
organisation_user
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
organisation_user.added | added | Organisation User |
organisation_user.deleted | deleted | Organisation User |
product
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
product.deleted | deleted | Product Delete Payload |
product.new | new | Product Payload |
product.updated | updated | Product Payload |
product_channel_status
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
product_channel_status.changed | changed | ProductChannelStatusChanged |
product_channel_status.removed | removed | ProductChannelStatusRemoved |
product_inventory
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
product_inventory.delete | delete | Product Inventory Delete Payload |
product_inventory.delta_update | delta_update | Product Inventory Delta Update Payload |
product_inventory.update | update | Product Inventory Update Payload |
product_relation
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
product_relation.deleted | deleted | Product Relation Deleted Payload |
product_relation.updated | updated | Product Relation Updated Payload |
product_relation_product
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
product_relation_product.deleted | deleted | Product Relation Product Detach Payload |
product_status
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
product_status.changed | changed | Product Status Changed Payload |
product_stock_config
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
product_stock_config.update | update | Product Stock Config Update Payload |
product_variant
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
product_variant.deleted | deleted | Product Variant Delete Payload |
product_variant.new | new | Product Variant Payload |
product_variant.updated | updated | Product Variant Payload |
product_variant_price
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
product_variant_price.updated | updated | ProductVariantPricesUpdatedPayload |
product_variant_single_price
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
product_variant_single_price.deleted | deleted | ProductVariantSinglePriceDeletedPayload |
product_variant_single_price.updated | updated | ProductVariantSinglePriceUpdatedPayload |
product_variant_status
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
product_variant_status.changed | changed | Product Variant Status Changed Payload |
redirect
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
redirect.created | created | RedirectPayload |
redirect.deleted | deleted | RedirectsDeletedPayload |
reporting
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
reporting.created | created | Reporting |
store_group
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
store_group.deleted | deleted | StoreGroupDeletedPayload |
store_group.updated | updated | StoreGroupUpdatedPayload |
store_group_market
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
store_group_market.deleted | deleted | StoreGroupMarketDeletedPayload |
store_group_market.updated | updated | StoreGroupMarketUpdatedPayload |
sync
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
sync.created | created | SyncCreatedPayload |
tag
Count: 4
| Event type | Action | Payload schema |
|---|---|---|
tag.deleted | deleted | TagDeletedPayload |
tag.relationship_created | relationship_created | TagRelationshipPayload |
tag.relationship_removed | relationship_removed | TagRelationshipPayload |
tag.updated | updated | TagUpdatedPayload |
tag_order
Count: 1
| Event type | Action | Payload schema |
|---|---|---|
tag_order.updated | updated | RelationshipOrder |
tax_group
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
tax_group.deleted | deleted | Tax Group Deleted Payload |
tax_group.updated | updated | Tax Group Updated Payload |
tax_group_market
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
tax_group_market.deleted | deleted | Tax Group Market Deleted Payload |
tax_group_market.updated | updated | Tax Group Market Updated Payload |
team
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
team.created | created | Team Payload |
team.deleted | deleted | Team Deleted Payload |
team.updated | updated | Team Payload |
team_user
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
team_user.added | added | Team User Payload |
team_user.delete | delete | Team User Payload |
token
Count: 3
| Event type | Action | Payload schema |
|---|---|---|
token.created | created | Token |
token.deleted | deleted | TokenDeleted |
token.updated | updated | Token |
translation
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
translation.delete | delete | Translation Delete Payload |
translation.upsert | upsert | Translation |
user
Count: 8
| Event type | Action | Payload schema |
|---|---|---|
user.created | created | User |
user.deleted | deleted | User Deleted Payload |
user.reset_password | reset_password | Reset Password |
user.set_password | set_password | User Set Password Payload |
user.status_updated | status_updated | User Status Changed Payload |
user.updated | updated | User |
user.verify_email | verify_email | Verify Email |
user.verify_email_success | verify_email_success | Verify Email |
user_content
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
user_content.deleted | deleted | User Content Deleted Payload |
user_content.uploaded | uploaded | User Content Upload Payload |
variant_group
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
variant_group.deleted | deleted | Variant Group Deleted Payload |
variant_group.upsert | upsert | Variant Group Upsert Payload |
variant_group_channel_status
Count: 2
| Event type | Action | Payload schema |
|---|---|---|
variant_group_channel_status.changed | changed | VariantGroupChannelStatusChanged |
variant_group_channel_status.removed | removed | VariantGroupChannelStatusRemoved |
video
Count: 5
| Event type | Action | Payload schema |
|---|---|---|
video.deleted | deleted | Video Deleted Payload |
video.relationship_created | relationship_created | Video Relationship Payload |
video.relationship_removed | relationship_removed | Video Relationship Payload |
video.uploaded | uploaded | Video Uploaded Payload |
video.upserted | upserted | Video |
virtual_bundle
Count: 6
| Event type | Action | Payload schema |
|---|---|---|
virtual_bundle.created | created | Virtual Bundle Payload |
virtual_bundle.deleted | deleted | Virtual Bundle Delete Payload |
virtual_bundle.product_added | product_added | Virtual Bundle product Added Payload |
virtual_bundle.product_removed | product_removed | Virtual Bundle product Removed Payload |
virtual_bundle.product_updated | product_updated | Virtual Bundle product Updated Payload |
virtual_bundle.updated | updated | Virtual Bundle Payload |
Payload schemas
Fields marked with * are required at the top level of that payload schema. Nested object and referenced-schema details remain owned by the schema contract; this page summarizes the top-level payload contract for routing, handler planning, and agent lookup.
AI Generated Content
Schema ID: https://enad.io/schemas/common/ai_generated_content.json
Description: AI-generated content for various item types
Required fields: item_id, item_type, fields
Top-level fields: fields, item_id, item_type*
Composition: -
Ordering key: item_id
App Settings
Schema ID: https://enad.io/schemas/common/app_settings.json
Description: Application settings configuration
Required fields: enad_ai_enabled, app_id, max_tokens, max_images_generated, max_videos_generated
Top-level fields: app_id, enad_ai_enabled, max_images_generated, max_tokens, max_videos_generated*
Composition: -
Ordering key: app_id
Image
Schema ID: https://enad.io/schemas/common/image.json
Description: Image metadata and configuration
Required fields: id, url, alt, status, title, copyright, sort, attributes, custom_fields, translations, folder_id
Top-level fields: alt, attributes, blurhash, copyright, custom_fields, folder_id, id, sort, status, title, translations, url*
Composition: -
Ordering key: id
Market
Schema ID: https://enad.io/schemas/common/market.json
Description: A market configuration
Required fields: id, name, slug, country_codes, locale, currency_code, created_at
Top-level fields: active, country_codes, created_at, currency_code, id, locale, name, slug*, updated_at
Composition: -
Ordering key: id
Organisation
Schema ID: https://enad.io/schemas/common/organisation.json
Description: Organisation/company information
Required fields: id, company_name, contact_name, credit_check, email, invoice_email, custom_fields, phone, tax_id_vat, external_ref, store_group_ids, shipping, billing, status, attributes, tags
Top-level fields: attributes, billing, comment, company_name, contact_name, credit_check, custom_fields, customer_group_ids, email, external_ref, id, invoice_email, organisation_number, parent_id, phone, shipping, status, store_group_ids, tags, tax_id_vat
Composition: -
Ordering key: id
Organisation User
Schema ID: https://enad.io/schemas/common/organisation_user.json
Description: User membership in an organisation
Required fields: organisation_id, user_id, custom_role_id, level
Top-level fields: custom_role_id, level, organisation_id, user_id
Composition: -
Ordering key: organisation_id
Product File
Schema ID: https://enad.io/schemas/common/product_file.json
Description: Product file metadata
Required fields: id, url, title, type, translations, attributes, folder_id
Top-level fields: attributes, folder_id, id, title, translations, type, url*
Composition: -
Ordering key: id
RelationshipOrder
Schema ID: https://enad.io/schemas/common/relationship_order.json
Description: Ordering information for relationships
Required fields: item_id
Top-level fields: item_id*, order
Composition: -
Ordering key: item_id
Reporting
Schema ID: https://enad.io/schemas/common/reporting.json
Description: Usage reporting metrics
Required fields: request_id, service, event_type, requests_amount, transformed_images_amount, tokens, cache_hits, created_at
Top-level fields: ai_model, ai_provider, bandwidth_bytes, cache_hits, created_at, event_type, images_generated, request_id, requests_amount, service, tokens, transformed_images_amount, videos_generated
Composition: -
Ordering key: request_id
Reset Password
Schema ID: https://enad.io/schemas/common/reset_password.json
Description: Password reset request information
Required fields: -
Top-level fields: -
Composition: allOf
Ordering key: id
Token
Schema ID: https://enad.io/schemas/common/token.json
Description: API token information
Required fields: id, token, resource, app_id, permissions, created_at
Top-level fields: app_id, created_at, expires_at, id, permissions, resource, token, updated_at
Composition: -
Ordering key: id
Translation
Schema ID: https://enad.io/schemas/common/translation.json
Description: A translation entry with locale and value
Required fields: id, locale, value
Top-level fields: id, locale, value*
Composition: -
Ordering key: id
User
Schema ID: https://enad.io/schemas/common/user.json
Description: User account information
Required fields: id, email, additions, email_verified, communication_preferences, address, send_email_verification_link, email_verification_token, tags, status, attributes, is_super_admin
Top-level fields: additions, address, attributes, communication_preferences, customer_group_ids, email, email_verification_token, email_verified, first_name, id, is_super_admin, language, last_name, market, phone_number, send_email_verification_link, status, store_group, tags
Composition: -
Ordering key: id
Verify Email
Schema ID: https://enad.io/schemas/common/verify_email.json
Description: Email verification information
Required fields: -
Top-level fields: -
Composition: allOf
Ordering key: id
Video
Schema ID: https://enad.io/schemas/common/video.json
Description: Video metadata and configuration
Required fields: id, url, status, title, translations, attributes, folder_id
Top-level fields: attributes, description, folder_id, id, status, title, translations, url*
Composition: -
Ordering key: id
App Payload
Schema ID: https://enad.io/schemas/payloads/apps/app.json
Description: Payload for app.created and app.updated events
Required fields: id, app_slug, team_slug, name, available_languages, default_language, environment
Top-level fields: app_slug, available_languages, avatar_url, default_language, environment, id, name, parent_id, team_slug*
Composition: -
Ordering key: id
App Deleted Payload
Schema ID: https://enad.io/schemas/payloads/apps/app_deleted.json
Description: Payload for app.deleted event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
AttributeDeletedPayload
Schema ID: https://enad.io/schemas/payloads/attributes/attribute_deleted.json
Description: Payload for attribute deleted events
Required fields: attribute_id
Top-level fields: attribute_id*
Composition: -
Ordering key: attribute_id
AttributeRelationshipCreatedPayload
Schema ID: https://enad.io/schemas/payloads/attributes/attribute_relationship_created.json
Description: Payload for attribute relationship created events
Required fields: attribute_id
Top-level fields: attribute_id*, item_ids
Composition: -
Ordering key: item_ids[0]
AttributeRelationshipDeletedPayload
Schema ID: https://enad.io/schemas/payloads/attributes/attribute_relationship_deleted.json
Description: Payload for attribute relationship removed events
Required fields: attribute_id
Top-level fields: attribute_id*, item_ids
Composition: -
Ordering key: item_ids[0]
AttributeUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/attributes/attribute_updated.json
Description: Payload for attribute updated events
Required fields: attribute
Top-level fields: attribute*, resources
Composition: -
Ordering key: attribute.id
BrandPayload
Schema ID: https://enad.io/schemas/payloads/brands/brand.json
Description: Payload for brand created/updated events
Required fields: id, name, slug, type
Top-level fields: address, cover_id, description, email, id, logo_id, name, parent_id, parent_name, parent_slug, series, slug, type
Composition: -
Ordering key: id
BrandDeletePayload
Schema ID: https://enad.io/schemas/payloads/brands/brand_deleted.json
Description: Payload for brand deleted events
Required fields: type, id
Top-level fields: brand_id, children_ids, id, type
Composition: -
Ordering key: id
Bundle Group Payload
Schema ID: https://enad.io/schemas/payloads/bundles/bundle_group.json
Description: Payload for bundle.upsert event
Required fields: id, store_markets, bundles, name, name_translations, description, description_translations, is_active
Top-level fields: bundles, description, description_translations, id, is_active, name, name_translations, store_markets, valid_date_range
Composition: -
Ordering key: id
Bundle Group Delete Payload
Schema ID: https://enad.io/schemas/payloads/bundles/bundle_group_delete.json
Description: Payload for bundle.delete event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Category Payload
Schema ID: https://enad.io/schemas/payloads/categories/category.json
Description: Payload for category.created and category.updated events
Required fields: id, name, slug, status, translations, attributes, redirects, childless, sort_order, created_at
Top-level fields: attributes, childless, cover_url, created_at, full_uri, google_product_category_id, id, name, parent_id, redirects, slug, sort_order, status, translations, updated_at
Composition: -
Ordering key: id
Category Delete Payload
Schema ID: https://enad.io/schemas/payloads/categories/category_delete.json
Description: Payload for category.deleted event
Required fields: id
Top-level fields: children, id*
Composition: -
Ordering key: id
Category Relationship Created Payload
Schema ID: https://enad.io/schemas/payloads/categories/category_relationship_created.json
Description: Payload for category_relationship.created event
Required fields: product_id, category, order, is_main_category
Top-level fields: category, is_main_category, order, product_id
Composition: -
Ordering key: product_id
Category Relationship Deleted Payload
Schema ID: https://enad.io/schemas/payloads/categories/category_relationship_deleted.json
Description: Payload for category_relationship.deleted event
Required fields: product_id, category
Top-level fields: category, product_id
Composition: -
Ordering key: product_id
ChannelContentDeleted
Schema ID: https://enad.io/schemas/payloads/channels/channel_content_deleted.json
Description: Payload for channel_content.deleted events. Emitted when channel-specific content is deleted.
Required fields: content_id, channel_id, parent_id, parent_type, field_type, timestamp
Top-level fields: channel_id, content_id, field_type, parent_id, parent_type, timestamp
Composition: -
Ordering key: content_id
ChannelContentUpserted
Schema ID: https://enad.io/schemas/payloads/channels/channel_content_upserted.json
Description: Payload for channel_content.upserted events. Emitted when channel-specific content is created or updated.
Required fields: content_id, channel_id, parent_id, parent_type, field_type, value, relationships, translations, timestamp
Top-level fields: channel_id, content_id, field_type, parent_id, parent_type, relationships, timestamp, translations, value*
Composition: -
Ordering key: content_id
ChannelCreated
Schema ID: https://enad.io/schemas/payloads/channels/channel_created.json
Description: Payload for channel created events
Required fields: id, name, slug, active, store_group_id
Top-level fields: active, description, id, market_ids, name, slug, store_group_id*
Composition: -
Ordering key: id
ChannelDeleted
Schema ID: https://enad.io/schemas/payloads/channels/channel_deleted.json
Description: Payload for channel deleted events
Required fields: id, slug, store_group_id
Top-level fields: id, market_ids, slug, store_group_id*
Composition: -
Ordering key: id
ChannelUpdated
Schema ID: https://enad.io/schemas/payloads/channels/channel_updated.json
Description: Payload for channel updated events
Required fields: id, name, slug, active, store_group_id
Top-level fields: active, description, id, market_ids, name, slug, store_group_id*
Composition: -
Ordering key: id
ProductChannelStatusChanged
Schema ID: https://enad.io/schemas/payloads/channels/product_channel_status_changed.json
Description: Payload for product_channel_status.changed events. Emitted when a product is added to a channel or its channel status flips.
Required fields: product_id, product_number, channel_id, channel_slug, new_status, timestamp
Top-level fields: channel_id, channel_slug, new_status, product_id, product_number, timestamp
Composition: -
Ordering key: product_id
ProductChannelStatusRemoved
Schema ID: https://enad.io/schemas/payloads/channels/product_channel_status_removed.json
Description: Payload for product_channel_status.removed events. Emitted when a product is removed from a channel.
Required fields: product_id, product_number, channel_id, channel_slug, timestamp
Top-level fields: channel_id, channel_slug, product_id, product_number, timestamp*
Composition: -
Ordering key: product_id
VariantGroupChannelStatusChanged
Schema ID: https://enad.io/schemas/payloads/channels/variant_group_channel_status_changed.json
Description: Payload for variant_group_channel_status.changed events. Emitted when a variant group is added to a channel or its channel status flips.
Required fields: variant_group_id, product_id, channel_id, channel_slug, new_status, timestamp
Top-level fields: channel_id, channel_slug, new_status, product_id, timestamp, variant_group_id
Composition: -
Ordering key: variant_group_id
VariantGroupChannelStatusRemoved
Schema ID: https://enad.io/schemas/payloads/channels/variant_group_channel_status_removed.json
Description: Payload for variant_group_channel_status.removed events. Emitted when a variant group is removed from a channel.
Required fields: variant_group_id, product_id, channel_id, channel_slug, timestamp
Top-level fields: channel_id, channel_slug, product_id, timestamp, variant_group_id*
Composition: -
Ordering key: variant_group_id
Collection Payload
Schema ID: https://enad.io/schemas/payloads/collections/collection.json
Description: Payload for collection.created and collection.updated events
Required fields: id, slug, title, status, translations
Top-level fields: id, parent_id, slug, status, title, translations*
Composition: -
Ordering key: id
Collection Delete Payload
Schema ID: https://enad.io/schemas/payloads/collections/collection_delete.json
Description: Payload for collection.deleted event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Collection Relationship Payload
Schema ID: https://enad.io/schemas/payloads/collections/collection_relationship.json
Description: Payload for collection.relationship_created and collection.relationship_removed events
Required fields: collection, product_id, order
Top-level fields: collection, order, product_id*
Composition: -
Ordering key: product_id
CustomRoleDeletedPayload
Schema ID: https://enad.io/schemas/payloads/custom_roles/custom_role_deleted.json
Description: Payload for deleting custom role
Required fields: slug, name, id
Top-level fields: id, name, slug*
Composition: -
Ordering key: id
CustomRoleUpsertedPayload
Schema ID: https://enad.io/schemas/payloads/custom_roles/custom_role_upserted.json
Description: Payload for upserting custom role
Required fields: name, slug, id, is_default
Top-level fields: id, is_default, name, slug
Composition: -
Ordering key: id
CustomerGroupProductVariantPricesUpsertedPayload
Description: Payload for customer group product variant prices upserted events
Required fields: customer_group_id, product_variant_id, markets
Top-level fields: customer_group_id, markets, product_variant_id*
Composition: -
Ordering key: customer_group_id
CustomerGroupDeletedPayload
Schema ID: https://enad.io/schemas/payloads/customer_groups/customer_group_deleted.json
Description: Payload for deleting customer group
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
CustomerGroupUpsertedPayload
Schema ID: https://enad.io/schemas/payloads/customer_groups/customer_group_upserted.json
Description: Payload for upserting customer group
Required fields: name, slug, id, store_group_id
Top-level fields: discount_percentage, discount_percentage_decimals, id, name, slug, store_group_id
Composition: -
Ordering key: id
DamFolderDeletedPayload
Schema ID: https://enad.io/schemas/payloads/dam/folder_deleted.json
Description: Payload for DAM folder deleted events
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
DamFolderUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/dam/folder_updated.json
Description: Payload for DAM folder updated events
Required fields: id, name, slug, public, created_at
Top-level fields: created_at, id, name, parent_id, public, slug*, updated_at
Composition: -
Ordering key: id
DamFolderShareableLinkDeletedPayload
Schema ID: https://enad.io/schemas/payloads/dam/shareable_link_deleted.json
Description: Payload for DAM folder shareable link deleted events
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
DamFolderShareableLinkUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/dam/shareable_link_updated.json
Description: Payload for DAM folder shareable link updated events
Required fields: id, token, folder_ids, image_ids, video_ids, file_ids, created_at
Top-level fields: created_at, expires_at, file_ids, folder_ids, id, image_ids, token, updated_at, video_ids*
Composition: -
Ordering key: id
Enad User Deleted Payload
Schema ID: https://enad.io/schemas/payloads/enad_users/enad_user_deleted.json
Description: Payload for enad_user.delete event
Required fields: user_id
Top-level fields: user_id*
Composition: -
Ordering key: user_id
Enad User Upsert Payload
Schema ID: https://enad.io/schemas/payloads/enad_users/enad_user_upsert.json
Description: Payload for enad_user.upsert event
Required fields: id, clerk_id, created_at
Top-level fields: avatar_url, clerk_id, created_at, first_name, id*, last_name, updated_at
Composition: -
Ordering key: id
FeedDeletedPayload
Schema ID: https://enad.io/schemas/payloads/feeds/feed_deleted.json
Description: Payload for feed deleted events
Required fields: id, key
Top-level fields: id, key
Composition: -
Ordering key: id
FeedUpdatePayload
Schema ID: https://enad.io/schemas/payloads/feeds/feed_updated.json
Description: Payload for feed updated events
Required fields: id, key, market_id, store_group_id, online_warehouse_id, field_mapping, available_languages
Top-level fields: available_languages, custom_field_mapping, description, feed_type, field_mapping, hide_products_without_categories, hide_products_without_price, id, key, market_id, online_warehouse_id, only_variants, product_per_line, refresh_interval_minutes, shipping, store_group_id*, title
Composition: -
Ordering key: id
Product File Deleted Payload
Schema ID: https://enad.io/schemas/payloads/files/product_file_deleted.json
Description: Payload for files.deleted event
Required fields: file_id
Top-level fields: file_id*
Composition: -
Ordering key: file_id
Image Deleted Payload
Schema ID: https://enad.io/schemas/payloads/images/image_deleted.json
Description: Payload for image.deleted event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Image Relationship Payload
Schema ID: https://enad.io/schemas/payloads/images/image_relationship.json
Description: Payload for image.relationship_created and image.relationship_removed events
Required fields: image, item_id, order
Top-level fields: image, item_id, order*
Composition: -
Ordering key: item_id
Integration Delete Payload
Schema ID: https://enad.io/schemas/payloads/integrations/integration_delete.json
Description: Payload for integration.delete event
Required fields: integration_id
Top-level fields: integration_id*
Composition: -
Ordering key: integration_id
Integration New Payload
Schema ID: https://enad.io/schemas/payloads/integrations/integration_new.json
Description: Payload for integration.new event
Required fields: integration_id, app_slug, team_slug, integration_type, name
Top-level fields: app_slug, custom, integration_id, integration_type, name, team_slug*
Composition: -
Ordering key: integration_id
Integration Update Payload
Schema ID: https://enad.io/schemas/payloads/integrations/integration_update.json
Description: Payload for integration.update event
Required fields: integration_id, integration_type, app_slug, team_slug, name
Top-level fields: app_slug, custom, integration_id, integration_type, name, team_slug*
Composition: -
Ordering key: integration_id
Inventory Deleted Payload
Schema ID: https://enad.io/schemas/payloads/inventory/inventory_deleted.json
Description: Payload for inventory.deleted event
Required fields: id
Top-level fields: available_online, id*
Composition: -
Ordering key: id
Inventory Revoked From Online Payload
Schema ID: https://enad.io/schemas/payloads/inventory/inventory_revoked_from_online.json
Description: Payload for inventory.revoked_from_online event
Required fields: inventory_id
Top-level fields: inventory_id*
Composition: -
Ordering key: inventory_id
Inventory Updated Payload
Schema ID: https://enad.io/schemas/payloads/inventory/inventory_updated.json
Description: Payload for inventory.updated event
Required fields: id, name, slug, description
Top-level fields: address, available_online, description, id, name, slug
Composition: -
Ordering key: id
Market Inventories Update Payload
Schema ID: https://enad.io/schemas/payloads/inventory/market_inventories_update.json
Description: Payload for market_inventories.update event
Required fields: market_id, store_group_id, inventories
Top-level fields: inventories, market_id, store_group_id*
Composition: -
Ordering key: store_group_id
Product Inventory Delete Payload
Schema ID: https://enad.io/schemas/payloads/inventory/product_inventory_delete.json
Description: Payload for product_inventory.delete event
Required fields: product_parent_id, product_variant_id, product_variant_number, inventory_id, inventory_slug
Top-level fields: available_online, inventory_id, inventory_slug, product_parent_id, product_variant_id, product_variant_number*
Composition: -
Ordering key: product_parent_id
Product Inventory Delta Update Payload
Schema ID: https://enad.io/schemas/payloads/inventory/product_inventory_delta_update.json
Description: Payload for product_inventory.delta_update event
Required fields: inventory_id, inventory_slug, variant_id, product_variant_number
Top-level fields: available_online, inventory_date, inventory_id, inventory_slug, product_variant_number, quantity, total_quantity, validate_stock, variant_id
Composition: -
Ordering key: variant_id
Product Inventory Update Payload
Schema ID: https://enad.io/schemas/payloads/inventory/product_inventory_update.json
Description: Payload for product_inventory.update event
Required fields: inventory_id, inventory_slug, product_parent_id, product_variant_id, product_variant_number, update_source
Top-level fields: available_online, created, inventory_date, inventory_id, inventory_slug, product_parent_id, product_variant_id, product_variant_number, quantity, stock_updated, update_source, validate_stock
Composition: -
Ordering key: product_parent_id
Product Stock Config Update Payload
Schema ID: https://enad.io/schemas/payloads/inventory/product_stock_config_update.json
Description: Payload for product_stock_config.update event
Required fields: product_parent_id, product_variant_id, product_variant_number
Top-level fields: product_parent_id, product_variant_id, product_variant_number*, validate_stock
Composition: -
Ordering key: product_parent_id
MarketDeletedPayload
Schema ID: https://enad.io/schemas/payloads/markets/market_deleted.json
Description: Payload for market deleted events
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Order Payload
Schema ID: https://enad.io/schemas/payloads/orders/order.json
Description: Payload for order.updated event
Required fields: order_status, id, source, order_date, currency_code, language_code, session_id, country_code, sub_total, tax_total, discount_total, shipping_total, gift_card_total, bonus_total, grand_total, reference, payment_method_id, payment_method_name, shipping_methods, billing_address, shipping_address, order_discount, order_lines, created_at, order_merchant_information
Top-level fields: billing_address, bonus_total, country_code, created_at, currency_code, discount_total, gift_card_total, grand_total, id, language_code, order_date, order_discount, order_lines, order_merchant_information, order_status, payment_method_id, payment_method_name, reference, session_id, shipping_address, shipping_methods, shipping_total, source, sub_total, tax_total*
Composition: -
Ordering key: id
Order Deleted Payload
Schema ID: https://enad.io/schemas/payloads/orders/order_deleted.json
Description: Payload for order.deleted event
Required fields: order_id
Top-level fields: order_id*
Composition: -
Ordering key: order_id
Organisation Address User Restriction Added Payload
Schema ID: https://enad.io/schemas/payloads/organisations/organisation_address_user_restriction_added.json
Description: Payload for organisation_address_user.restriction event
Required fields: organisation_id, merchant_user_id, address_id
Top-level fields: address_id, merchant_user_id, organisation_id*
Composition: -
Ordering key: organisation_id
Organisation Address User Restriction Deleted Payload
Schema ID: https://enad.io/schemas/payloads/organisations/organisation_address_user_restriction_deleted.json
Description: Payload for organisation_address_user.delete event
Required fields: organisation_id, merchant_user_id, address_id
Top-level fields: address_id, merchant_user_id, organisation_id*
Composition: -
Ordering key: organisation_id
Organisation Deleted Payload
Schema ID: https://enad.io/schemas/payloads/organisations/organisation_deleted.json
Description: Payload for organisation.deleted event
Required fields: id
Top-level fields: id*, org_number
Composition: -
Ordering key: id
Organisation Status Changed Payload
Schema ID: https://enad.io/schemas/payloads/organisations/organisation_status_changed.json
Description: Payload for organisation_status.changed event
Required fields: organisation_id, to_status, old_status
Top-level fields: old_status, org_number, organisation_id, to_status*
Composition: -
Ordering key: organisation_id
Product Relation Deleted Payload
Schema ID: https://enad.io/schemas/payloads/product_relations/product_relation_deleted.json
Description: Payload for product_relation.deleted event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Product Relation Product Detach Payload
Schema ID: https://enad.io/schemas/payloads/product_relations/product_relation_product_detach.json
Description: Payload for product_relation_product.deleted event
Required fields: id
Top-level fields: id*, products
Composition: -
Ordering key: id
Product Relation Updated Payload
Schema ID: https://enad.io/schemas/payloads/product_relations/product_relation_updated.json
Description: Payload for product_relation.updated event
Required fields: id, title, type
Top-level fields: direction, id, main_product, products, title, type*
Composition: -
Ordering key: id
ProductVariantPricesUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/product_variant_prices/variant_prices_updated.json
Description: Payload for product variant prices updated events
Required fields: variant_id, product_id, store_group_id, store_group_slug, variant_number, markets
Top-level fields: markets, product_id, store_group_id, store_group_slug, variant_id, variant_number
Composition: -
Ordering key: product_id
ProductVariantSinglePriceDeletedPayload
Schema ID: https://enad.io/schemas/payloads/product_variant_prices/variant_single_price_deleted.json
Description: Payload for single product variant price deleted events
Required fields: variant_id, product_id, store_group_id, store_group_slug, variant_number, market, price_id
Top-level fields: market, price_id, product_id, store_group_id, store_group_slug, variant_id, variant_number*
Composition: -
Ordering key: product_id
ProductVariantSinglePriceUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/product_variant_prices/variant_single_price_updated.json
Description: Payload for single product variant price updated events
Required fields: price_id, variant_id, product_id, store_group_id, store_group_slug, variant_number, market
Top-level fields: market, price_id, product_id, store_group_id, store_group_slug, variant_id, variant_number*
Composition: -
Ordering key: product_id
Product Payload
Schema ID: https://enad.io/schemas/payloads/products/product.json
Description: Payload for product.new and product.updated events
Required fields: app_slug, team_slug, product_id, product_name, product_number, slug, status, markets, categories, tags, is_active, variants, collections
Top-level fields: app_slug, attributes, brand, categories, collections, custom, description, description_translations, exclude_from_feeds, files, html_description, html_description_translations, html_short_description, html_short_description_translation, images, is_active, is_archive, market_status, markets, package_dimensions, product_dimensions, product_id, product_name, product_name_translations, product_number, product_type, redirects, seo, short_description, short_description_translation, slug, slug_translations, status, tags, tax_group_id, team_slug, third_party_links, variant_groups, variants*
Composition: -
Ordering key: product_id
Product Delete Payload
Schema ID: https://enad.io/schemas/payloads/products/product_delete.json
Description: Payload for product.deleted event
Required fields: product_id, product_number
Top-level fields: product_id, product_number
Composition: -
Ordering key: product_id
Product Status Changed Payload
Schema ID: https://enad.io/schemas/payloads/products/product_status_changed.json
Description: Payload for product_status.changed event
Required fields: product_id, product_number, old_status, new_status, timestamp
Top-level fields: new_status, old_status, product_id, product_number, timestamp*
Composition: -
Ordering key: product_id
Product Variant Payload
Schema ID: https://enad.io/schemas/payloads/products/product_variant.json
Description: Payload for product_variant.new and product_variant.updated events
Required fields: product_number, product_id, variant_name, variant_number, id, is_active, taxGroupId, categories, collections
Top-level fields: attributes, brand, categories, collections, custom_attributes, custom_fields, custom_tags, description, display_descriptions, display_names, id, image_url, images, is_active, is_archive, listings, package_dimensions, prices, product_dimensions, product_id, product_number, purchase_price, shipping_attributes, status, stock, tags, taxGroupId, validate_stock, variant_dimensions, variant_group_id, variant_name, variant_number*
Composition: -
Ordering key: product_id
Product Variant Delete Payload
Schema ID: https://enad.io/schemas/payloads/products/product_variant_delete.json
Description: Payload for product_variant.deleted event
Required fields: variant_id, variant_number, product_parent_id
Top-level fields: product_parent_id, variant_id, variant_number*
Composition: -
Ordering key: product_parent_id
Product Variant Status Changed Payload
Schema ID: https://enad.io/schemas/payloads/products/product_variant_status_changed.json
Description: Payload for product_variant_status.changed event
Required fields: product_id, product_number, variant_id, variant_number, old_status, new_status, timestamp
Top-level fields: new_status, old_status, product_id, product_number, timestamp, variant_id, variant_number*
Composition: -
Ordering key: product_id
RedirectPayload
Schema ID: https://enad.io/schemas/payloads/redirects/redirect_created.json
Description: Payload for redirect created events
Required fields: id, old_slug, new_slug, locale, redirect_type
Top-level fields: id, item_id, locale, new_slug, old_slug, redirect_type*
Composition: -
Ordering key: old_slug
RedirectsDeletedPayload
Schema ID: https://enad.io/schemas/payloads/redirects/redirect_deleted.json
Description: Payload for redirect deleted events
Required fields: -
Top-level fields: ids
Composition: -
Ordering key: ids[0]
StoreGroupDeletedPayload
Schema ID: https://enad.io/schemas/payloads/store_groups/store_group_deleted.json
Description: Payload for store group deleted events
Required fields: id, slug
Top-level fields: id, slug
Composition: -
Ordering key: id
StoreGroupMarketDeletedPayload
Schema ID: https://enad.io/schemas/payloads/store_groups/store_group_market_deleted.json
Description: Payload for store group market deleted events
Required fields: store_group_id, store_group_slug, id, country_code
Top-level fields: country_code, id, store_group_id, store_group_slug
Composition: -
Ordering key: store_group_id
StoreGroupMarketUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/store_groups/store_group_market_updated.json
Description: Payload for store group market updated events
Required fields: store_group_id, store_group_slug, id, data
Top-level fields: data, id, store_group_id, store_group_slug
Composition: -
Ordering key: store_group_id
StoreGroupUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/store_groups/store_group_updated.json
Description: Payload for store group updated events
Required fields: id, slug, name, channel_type
Top-level fields: channel_type, country_of_sale, description, id, markets, name, slug
Composition: -
Ordering key: id
SyncCreatedPayload
Schema ID: https://enad.io/schemas/payloads/sync/sync_created.json
Description: Payload for sync created events
Required fields: type, app_id
Top-level fields: app_id, type
Composition: -
Ordering key: app_id
TagDeletedPayload
Schema ID: https://enad.io/schemas/payloads/tags/tag_deleted.json
Description: Payload for tag deleted events
Required fields: tag_id
Top-level fields: tag_id*
Composition: -
Ordering key: tag_id
TagRelationshipPayload
Schema ID: https://enad.io/schemas/payloads/tags/tag_relationship.json
Description: Payload for tag relationship created/removed events
Required fields: tag, item_id, type
Top-level fields: item_id, order, tag, type*
Composition: -
Ordering key: item_id
TagUpdatedPayload
Schema ID: https://enad.io/schemas/payloads/tags/tag_updated.json
Description: Payload for tag updated events
Required fields: tag
Top-level fields: tag*
Composition: -
Ordering key: tag.id
Tax Group Deleted Payload
Schema ID: https://enad.io/schemas/payloads/tax_groups/tax_group_deleted.json
Description: Payload for tax_group.deleted event
Required fields: id, slug
Top-level fields: id, slug
Composition: -
Ordering key: id
Tax Group Market Deleted Payload
Schema ID: https://enad.io/schemas/payloads/tax_groups/tax_group_market_deleted.json
Description: Payload for tax_group_market.deleted event
Required fields: id, countries, tax_group_id
Top-level fields: countries, id, tax_group_id*
Composition: -
Ordering key: tax_group_id
Tax Group Market Updated Payload
Schema ID: https://enad.io/schemas/payloads/tax_groups/tax_group_market_updated.json
Description: Payload for tax_group_market.updated event
Required fields: id, tax_group_id, countries
Top-level fields: countries, id, tax_group_id*
Composition: -
Ordering key: tax_group_id
Tax Group Updated Payload
Schema ID: https://enad.io/schemas/payloads/tax_groups/tax_group_updated.json
Description: Payload for tax_group.updated event
Required fields: id, name, description, is_default
Top-level fields: description, id, is_default, name
Composition: -
Ordering key: id
Team Payload
Schema ID: https://enad.io/schemas/payloads/teams/team.json
Description: Payload for team.created and team.updated events
Required fields: id, name, slug
Top-level fields: avatar_url, id, name, slug*
Composition: -
Ordering key: id
Team Deleted Payload
Schema ID: https://enad.io/schemas/payloads/teams/team_deleted.json
Description: Payload for team.deleted event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Team User Payload
Schema ID: https://enad.io/schemas/payloads/teams/team_user.json
Description: Payload for team_user.added and team_user.delete events
Required fields: id, team_id, clerk_id
Top-level fields: clerk_id, id, team_id*
Composition: -
Ordering key: team_id
TokenDeleted
Schema ID: https://enad.io/schemas/payloads/tokens/token_deleted.json
Description: Payload for token deleted events
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Translation Delete Payload
Schema ID: https://enad.io/schemas/payloads/translations/translation_delete.json
Description: Payload for translation.delete event
Required fields: translation_id
Top-level fields: translation_id*
Composition: -
Ordering key: translation_id
User Content Deleted Payload
Schema ID: https://enad.io/schemas/payloads/user_content/user_content_deleted.json
Description: Payload for user_content.deleted event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
User Content Upload Payload
Schema ID: https://enad.io/schemas/payloads/user_content/user_content_upload.json
Description: Payload for user_content.uploaded event
Required fields: id, url, file_name, relationship_ids, content_type, custom_fields
Top-level fields: content_type, custom_fields, file_name, id, order_reference, relationship_ids, url
Composition: -
Ordering key: id
User Deleted Payload
Schema ID: https://enad.io/schemas/payloads/users/user_deleted.json
Description: Payload for user.deleted event
Required fields: user, soft_delete
Top-level fields: soft_delete, user
Composition: -
Ordering key: user.id
User Set Password Payload
Schema ID: https://enad.io/schemas/payloads/users/user_set_password.json
Description: Payload for user.set_password event
Required fields: merchant_user_id, new_password
Top-level fields: merchant_user_id, new_password
Composition: -
Ordering key: merchant_user_id
User Status Changed Payload
Schema ID: https://enad.io/schemas/payloads/users/user_status_changed.json
Description: Payload for user.status_updated event
Required fields: user, to_status, old_status
Top-level fields: old_status, to_status, user*
Composition: -
Ordering key: user.id
Variant Group Deleted Payload
Schema ID: https://enad.io/schemas/payloads/variant_groups/variant_group_deleted.json
Description: Payload for deleted variant_groups
Required fields: variant_group_id, product_id
Top-level fields: product_id, variant_group_id
Composition: -
Ordering key: product_id
Variant Group Upsert Payload
Schema ID: https://enad.io/schemas/payloads/variant_groups/variant_group_upsert.json
Description: Payload for Variant groups
Required fields: variant_group, product_id
Top-level fields: product_id, variant_group
Composition: -
Ordering key: product_id
Video Deleted Payload
Schema ID: https://enad.io/schemas/payloads/videos/video_deleted.json
Description: Payload for video.deleted event
Required fields: id
Top-level fields: id*
Composition: -
Ordering key: id
Video Relationship Payload
Schema ID: https://enad.io/schemas/payloads/videos/video_relationship.json
Description: Payload for video.relationship_created and video.relationship_removed events
Required fields: video, item_id
Top-level fields: item_id, video
Composition: -
Ordering key: item_id
Video Uploaded Payload
Schema ID: https://enad.io/schemas/payloads/videos/video_uploaded.json
Description: Payload for video.uploaded event
Required fields: key
Top-level fields: key*
Composition: -
Ordering key: -
Virtual Bundle Payload
Schema ID: https://enad.io/schemas/payloads/virtual_bundles/virtual_bundle.json
Description: Payload for virtual_bundle.created and virtual_bundle.updated events
Required fields: id, app_id, name, bundle_number, status, slug, meta_title, meta_description, description, exclude_from_feeds, custom, products, created_at
Top-level fields: app_id, brand_id, bundle_number, created_at, custom, description, exclude_from_feeds, html_description, html_short_description, id, meta_description, meta_title, name, products, short_description, slug, status*, tax_group_id, updated_at
Composition: -
Ordering key: id
Virtual Bundle Delete Payload
Schema ID: https://enad.io/schemas/payloads/virtual_bundles/virtual_bundle_delete.json
Description: Payload for virtual_bundle.deleted event
Required fields: bundle_id, bundle_number
Top-level fields: bundle_id, bundle_number
Composition: -
Ordering key: bundle_id
Virtual Bundle product Added Payload
Schema ID: https://enad.io/schemas/payloads/virtual_bundles/virtual_bundle_product_added.json
Description: Payload for virtual_bundle.product_added event
Required fields: bundle_id, product
Top-level fields: bundle_id, product
Composition: -
Ordering key: bundle_id
Virtual Bundle product Removed Payload
Schema ID: https://enad.io/schemas/payloads/virtual_bundles/virtual_bundle_product_removed.json
Description: Payload for virtual_bundle.product_removed event
Required fields: bundle_id, product_id
Top-level fields: bundle_id, product_id
Composition: -
Ordering key: bundle_id
Virtual Bundle product Updated Payload
Schema ID: https://enad.io/schemas/payloads/virtual_bundles/virtual_bundle_product_updated.json
Description: Payload for virtual_bundle.product_updated event
Required fields: bundle_id, product
Top-level fields: bundle_id, product
Composition: -
Ordering key: bundle_id