A complete index
This page is a complete index of pre-defined topics, organized by the event topic's domain.
mechanic/actions/perform Occurs when an action has been performed, regardless of its success or failure. A task may subscribe to this topic to be notified when each of its actions have been performed, so that the task may then respond to the results.
mechanic/emails/received Occurs when Mechanic receives an email sent to the store's dedicated email address. (A store at example.myshopify.com can receive email at example@mail.usemechanic.com.)
mechanic/errors/action
Occurs when an action fails.
mechanic/errors/event Occurs when an event run fails.
mechanic/errors/task Occurs when a task run fails.
mechanic/scheduler/10min Runs every 10 minutes.
mechanic/scheduler/15min Runs every 15 minutes.
mechanic/scheduler/20min Runs every 20 minutes. (You see where this is going.)
mechanic/scheduler/30min Runs every 30 minutes.
mechanic/scheduler/hourly Runs every hour, on the hour.
mechanic/scheduler/daily Runs at midnight, in the store's local timezone.
mechanic/scheduler/monday Runs every Monday at midnight, in the store's local timezone. (Note: this would be at the end of Sunday evening). Each named weekday is supported.
mechanic/scheduler/monthly Runs at midnight on the 1st of the month, in the store's local timezone.
mechanic/user/trigger When used, adds a "Run task" button to the task itself. This button generates a new event, to which only this task will respond.
mechanic/user/text
When used, adds a "Run task" button to the task itself. This button prompts the user with a multi-line text box. When submitted, an event is generated, to which only this task will respond. The event contains the user's input in its data, making user's input available in event.data.
mechanic/user/collection Occurs when a user sends a collection to Mechanic
mechanic/user/customer mechanic/user/customers Occurs when a user sends one or more customers to Mechanic
mechanic/user/draft_order mechanic/user/draft_orders Occurs when a user sends one or more draft orders to Mechanic
mechanic/user/order mechanic/user/orders Occurs when a user sends one or more orders to Mechanic
mechanic/user/variant mechanic/user/variants Occurs when a user sends one or more product variants to Mechanic
mechanic/user/product mechanic/user/products Occurs when a user sends one or more products to Mechanic
Mechanic does not support Shopify event topics that are scoped to an individual app. For example, Shopify only sends product_listings/add events to the app responsible for the relevant sales channel, and only sends subscription_contracts/create events to the app responsible for the relevant customer subscriptions. This scoping renders topics like these irrelevant for apps like Mechanic.
shopify/carts/create
shopify/carts/update
shopify/channels/delete
shopify/checkouts/create
shopify/checkouts/delete
shopify/checkouts/update
shopify/collections/create
shopify/collections/delete
shopify/collections/update
shopify/companies/create
shopify/companies/delete
shopify/companies/update
shopify/company_contact_roles/assign
shopify/company_contact_roles/revoke
shopify/company_contacts/create
shopify/company_contacts/delete
shopify/company_contacts/update
shopify/company_locations/create
shopify/company_locations/delete
shopify/company_locations/update
shopify/customer/joined_segment
shopify/customer/left_segment
shopify/customer/tags_added
shopify/customer/tags_removed
shopify/customer_account_settings/update
shopify/customer_groups/create
shopify/customer_groups/delete
shopify/customer_groups/update
shopify/customers/create
shopify/customers/delete
shopify/customers/disable
shopify/customers/enable
shopify/customers/merge
shopify/customers/purchasing_summary
shopify/customers/update
shopify/customers_email_marketing_consent/update
shopify/customers_marketing_consent/update
shopify/delivery_promise_settings/update
shopify/discounts/create
shopify/discounts/delete
shopify/discounts/redeemcode_added
shopify/discounts/redeemcode_removed
shopify/discounts/update
shopify/disputes/create
shopify/disputes/update
shopify/domains/create
shopify/domains/destroy
shopify/domains/update
shopify/draft_orders/create
shopify/draft_orders/delete
shopify/draft_orders/update
shopify/fulfillment_events/create
shopify/fulfillment_events/delete
shopify/fulfillment_holds/added
shopify/fulfillment_holds/released
shopify/fulfillment_orders/cancellation_request_accepted
shopify/fulfillment_orders/cancellation_request_rejected
shopify/fulfillment_orders/cancellation_request_submitted
shopify/fulfillment_orders/cancelled
shopify/fulfillment_orders/fulfillment_request_accepted
shopify/fulfillment_orders/fulfillment_request_rejected
shopify/fulfillment_orders/fulfillment_request_submitted
shopify/fulfillment_orders/fulfillment_service_failed_to_complete
shopify/fulfillment_orders/hold_released
shopify/fulfillment_orders/line_items_prepared_for_local_delivery
shopify/fulfillment_orders/line_items_prepared_for_pickup
shopify/fulfillment_orders/merged
shopify/fulfillment_orders/moved
shopify/fulfillment_orders/order_routing_complete
shopify/fulfillment_orders/placed_on_hold
shopify/fulfillment_orders/rescheduled
shopify/fulfillment_orders/scheduled_fulfillment_order_ready
shopify/fulfillment_orders/split
shopify/fulfillments/create
shopify/fulfillments/update
shopify/inventory_items/create
shopify/inventory_items/delete
shopify/inventory_items/update
shopify/inventory_levels/connect
shopify/inventory_levels/disconnect
shopify/inventory_levels/update
shopify/locales/create
shopify/locales/update
shopify/locations/activate
shopify/locations/create
shopify/locations/deactivate
shopify/locations/delete
shopify/locations/update
shopify/markets/create
shopify/markets/delete
shopify/markets/update
shopify/metafield_definitions/create
shopify/metafield_definitions/delete
shopify/metafield_definitions/update
shopify/order_transactions/create
shopify/orders/cancelled
shopify/orders/create
shopify/orders/delete
shopify/orders/edited
shopify/orders/fulfilled
shopify/orders/paid
shopify/orders/partially_fulfilled
shopify/orders/risk_assessment_changed
shopify/orders/shopify_protect_eligibility_changed
shopify/orders/updated
shopify/payment_schedules/due
shopify/payment_terms/create
shopify/payment_terms/delete
shopify/payment_terms/update
shopify/product_feeds/create
shopify/product_feeds/full_sync
shopify/product_feeds/full_sync_finish
shopify/product_feeds/incremental_sync
shopify/product_feeds/update
shopify/products/create
shopify/products/delete
shopify/products/update
shopify/profiles/create
shopify/profiles/delete
shopify/profiles/update
shopify/publications/delete
shopify/refunds/create
shopify/returns/approve
shopify/returns/cancel
shopify/returns/close
shopify/returns/decline
shopify/returns/reopen
shopify/returns/request
shopify/returns/update
shopify/reverse_deliveries/attach_deliverable
shopify/reverse_fulfillment_orders/dispose
shopify/segments/create
shopify/segments/delete
shopify/segments/update
shopify/shop/update
shopify/tax_partners/update
shopify/tender_transactions/create
shopify/themes/create
shopify/themes/delete
shopify/themes/publish
shopify/themes/update
shopify/variants/in_stock
shopify/variants/out_of_stock
The User event domain is for custom, user-generated events, having any subject and verb (e.g. "user/foo/bar"). As with all events, a User event topic must use the standard three-part topic form, but only the "user/" prefix is mandatory.
Mechanic allows developers several ways to generate custom User events:
The Event action can be used with any User event topic
Webhooks may be configured to generate events using any User event topic
appstle_subscriptions/subscriptions/create — Occurs when a subscription is created.
appstle_subscriptions/subscriptions/activate — Occurs when a subscription is activated.
appstle_subscriptions/subscriptions/cancel — Occurs when a subscription is cancelled.
appstle_subscriptions/subscriptions/next_order_date_change — Occurs when the next order data of a subscription is changed.
appstle_subscriptions/subscriptions/pause — Occurs when a subscription is paused.
appstle_subscriptions/subscriptions/update — Occurs when a subscription is updated.
appstle_subscriptions/billings/create — Occurs when billing for a subscription is created.
appstle_subscriptions/billings/failure — Occurs when billing for a subscription fails.
appstle_subscriptions/billings/interval_change — Occurs when billing for a subscription changes.
Learn more about the Appstle Subscriptions integration here.
judgeme/review/created — Occurs when new Judge.me reviews are received. Requires enabling the Mechanic integration within Judge.me; see Judge.me's integration announcement.
judgeme/review/updated — Occurs when Judge.me reviews are updated. Requires enabling the Mechanic integration within Judge.me; see Judge.me's integration announcement.
report_toaster/reports/create — Occurs when a Report Toaster report has been created and is available for download. Learn more here.
report_toaster/reports/fail — Occurs when a requested Report Toaster report has failed. Learn more here.
Mechanic invites third-party app developers to develop Mechanic integrations, making it easy for developers to use our services together. If you're an app developer interested in this, email team@usemechanic.com.
An event filter is a small Liquid template that processes an incoming event, before handing the event off to the run system. If the template renders false, the event will be ignored. This makes event filters a light-weight mechanism for purposefully filtering out events, often for performance reasons.
This is often useful during large data migration operations, for stores that have Mechanic task subscribing to related topics. (For example: if a store has a task subscribing to shopify/customers/update, and the store's team is about to update hundreds of thousands of customers, they may wish to use Mechanic event filters to programmatically ignore all update events generated by the bulk update.)
Event filters should not be confused with Liquid filters.
Event filters are configured in an account's Mechanic settings.
An event filter has two parts:
Name – any descriptive string
Template – a Liquid template that renders false for events that should be ignored
When an event is received, Mechanic begins by running any event filters that are present on a store's Mechanic account. (Order is not guaranteed.) Mechanic renders each event filter template, providing the event and shop variables. If an event filter's result equals false, Mechanic halts processing of that event entirely. No tasks are run, in this scenario. Otherwise, processing continues normally, and tasks subscribing to the event's topic will run.
An event that wasn't processed will look something like this, in the Mechanic frontend:
This feature is useful if a Mechanic account is experiencing (or will experience) a large volume of events that (a) don't need to be processed at all, (b) would slow down your account if they were processed (learn more about concurrency), and (c) can be programmatically identified.
You can add, update, and remove event filters at any time. Any changes go into effect immediately.