The event object

The event object describes an incoming event.

How to access it

  • Use {{ event }} in any task script

What it contains

  • event.topic – containing the event topic (e.g. shopify/customers/create)
  • – containing all data that arrived with this event (e.g. the webhook payload from Shopify, the data from an incoming email, etc)
  • event.source – reflects the entity that triggered the event (e.g. "shopify", "user")
  • event.created_at – the date and time at which Mechanic received the event
  • 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

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.