event.md

Event object

The Event object describes an incoming event.

How to access it

• Use event in any task code
• Use event in the Liquid console when viewing an event in Mechanic

What it contains

• event.topic – containing the event topic (e.g. shopify/customers/create)

• event.data – containing all data that arrived with this event (e.g. the native webhook payload from Shopify, the payload after custom Shopify webhook customization, the data from an incoming email, etc)

• event.source – reflects the source that triggered the event (e.g. "shopify", "user", or custom_shopify_webhook_subscription:<uuid> for custom Shopify webhook deliveries)

• event.created_at – the date and time at which Mechanic received the event

• event.shopify_topic – on Shopify-sourced events (both native subscription deliveries and custom Shopify webhook deliveries), this contains the source Shopify topic in Mechanic's canonical form (e.g. shopify/products/update). For native deliveries it equals event.topic; for custom Shopify webhook deliveries, event.topic is the webhook's user/... topic and event.shopify_topic exposes the underlying Shopify topic. It's nil for non-Shopify events.

• event.parent – if applicable, a reference to the event that used an Event action to create this event; parents are available up to five generations deep (e.g. {{ event.parent.parent.parent.parent.parent }}), but no further

  In preview mode, this object also contains a "preview" attribute, as in event.preview, set to true. (In all other modes, event objects do not have this property.) When this attribute is present, the task should render actions that are indicative of what the merchant should expect the task to do – and these "preview" actions will be shown to the merchant. These actions will also be used to determine what Shopify permissions Mechanic will request from the merchant. Learn more about preview actions