Mechanic
đŸ“Ŗ Shopify REST Deprecation
  • â›Šī¸Introduction
  • 🤓Hire a Mechanic developer
  • đŸ’¯status.mechanic.dev
  • đŸ“ŖShopify is deprecating the REST API
  • 🙋"I need something custom!"
  • 🧑‍đŸ’ģ"I need help with my custom task!"
  • 🤖"I need help with my AI-written task!"
  • Resources
    • âŦ‡ī¸Install Mechanic
    • 🧑‍đŸ’ģTask library
      • Contributing
      • Requesting
    • 🚀Slack community
    • 🤝Partner directory
    • 🧠Tutorials
      • Video walkthroughs
        • Auto-tag orders by originating staff member
        • Maintain a tag for orders processed today
        • Auto-tag orders with their tracking numbers
        • Sync inventory for shared SKUs
        • Auto-tag products when their SKU(s) change
        • Auto-publish new products
        • Email a report of customers who haven't ordered in X days
        • Upgrading a Mechanic task: Adding a time delay
        • Email the customer when tracking numbers are added to their order
        • Adding an optional time delay to your Mechanic task
        • Delete all orders
        • Send an email when a specific product is shipped
        • Send recurring reminders about unpaid orders
        • Send an email when a product's price goes below its cost
        • Auto-tag customers by sales channel
        • Creating products in bulk
      • Creating a Mechanic webhook
      • Practicing writing tasks
      • Triggering tasks from a contact form
      • Creating scheduled CSV feeds
      • Fetching data from a shared Google sheet
    • 🏆Converting tasks from Shopify REST to GraphQL
      • Conversion: Single resource lookups
      • Conversion: Resource loops to paginated queries
      • Conversion: Connections from a resource
      • Conversion: Metafield lookups from a resource
      • Conversion: Resource lookups in task option fields
  • Core Concepts
    • Events
      • Topics
      • Parent and child events
    • Tasks
      • Subscriptions
      • Code
        • Environment variables
        • Action objects
        • Error objects
        • Log objects
      • Options
        • Custom validation
      • Previews
        • Defining preview events
        • Stub data
      • Shopify API version
      • Advanced settings
        • Documentation
        • JavaScript
        • Perform action runs in sequence
      • Import and export
      • User Form
    • Actions
      • Cache
      • Echo
      • Email
      • Event
      • Files
      • Flow
      • FTP
      • Google Drive
      • Google Sheets
      • HTTP
      • Integrations
        • Report Toaster
      • Shopify
      • File generators
        • Base64
        • PDF
        • Plaintext
        • URL
        • ZIP
    • Runs
      • Scheduling
      • Concurrency
      • Ordering
      • Retries
    • Interacting with Shopify
      • Responding to events
        • Reconciling missing events
      • Reading data
        • âš ī¸Liquid objects
        • 🏆GraphQL in Liquid
        • Bulk operations
        • The Shopify action
      • Writing data
      • Shopify admin action links
      • API rate limit
      • API versions
  • Platform
    • 🔆Policies
      • Data
      • Plans
      • Pricing
      • Privacy
    • Cache
      • Cache endpoints
    • Email
      • Receiving email
      • Custom email addresses
      • DMARC
      • Email templates
    • Error handling
    • Events
      • Event topics
      • Event filters
    • GraphQL
      • Basics
        • Shopify Admin API GraphiQL explorer
        • Queries
        • Mutations
        • Pagination
      • Bulk operations
    • Integrations
      • Appstle Subscriptions
      • Google Drive and Google Sheets
      • Judge.me
      • Locksmith
      • Report Toaster
      • Shopify Flow
      • Run links
    • Liquid
      • Basics
        • Syntax
        • Data types
        • Variables
        • Comments
        • Filters
        • Operators
        • Control flow
          • Condition
          • Iteration
        • Whitespace
      • Liquid console
      • Mechanic filters
        • Deprecated filters
      • Mechanic keyword literals
        • array
        • hash
        • newline
      • Mechanic objects
        • Action object
        • Cache object
        • Event object
        • Options object
        • Task object
        • âš ī¸Shopify REST Admin API
          • đŸšĢArticle object
          • đŸšĢBlog object
          • đŸšĢCollection object
          • đŸšĢCustomer object
          • đŸšĢDiscount code object
          • đŸšĢDispute object
          • đŸšĢDraft order object
          • đŸšĢFulfillment object
          • đŸšĢFulfillment order object
          • đŸšĢFulfillment event object
          • đŸšĢGift card object
          • đŸšĢInventory item object
          • đŸšĢInventory level object
          • đŸšĢLine item object
          • đŸšĢLocation object
          • đŸšĢMetafields
            • Metafield object
            • Metafield representation object
            • Metafield collection object
          • đŸšĢOrder object
          • đŸšĢOrder risk object
          • đŸšĢPrice rule object
          • đŸšĢProduct object
          • đŸšĢProduct image object
          • đŸšĢRefund object
          • đŸšĢShipping zone object
          • đŸšĢShop object
          • đŸšĢTheme object
          • đŸšĢTheme asset object
          • đŸšĢTransaction object
          • đŸšĢVariant object
      • Mechanic tags
        • liquid
        • action
        • assign
        • error
        • log
      • Mechanic code snippets
    • Shopify
      • Custom authentication
      • "Read all orders"
    • Webhooks
  • Techniques
    • Preventing action loops
    • Writing a high-quality task
    • Tagging Shopify resources
    • Debouncing events
    • Responding to action results
    • Working with external APIs
      • JSON Web Signatures
      • AWS request signatures
    • Finding a resource ID
    • Migrating templates from Shopify to Mechanic
    • Securing Mechanic webhooks
    • Monitoring Mechanic
  • FAQ
    • The app isn't loading. What do I do?
    • How do I stop a large batch of runs?
    • A Shopify event is missing. Where is it?
    • Does Mechanic have an affiliate program?
    • Can non-owners install Mechanic?
    • Can I replace Shopify's order emails with Mechanic?
    • Can I manually set Shopify permissions for Mechanic?
    • Does my theme need to be updated for Mechanic?
    • Do you have a plan for development stores?
    • Why don't I see any events in my task's activity?
    • Can I read data back from my webhook submission?
    • My task added a tag, but now the tag is missing – why?
    • How do I add an unsubscribe link to my emails?
    • How do I send images with my emails?
    • Can I re-send order confirmation emails with Mechanic?
    • Why am I seeing a different price than on the app store?
    • Do you have a Partner-friendly plan?
    • Why are my tasks delayed or not running?
    • My task is failing because of a permissions problem. Why?
    • How do I preview email attachments?
    • Can I query external APIs?
    • Why can't I access the Shopify API during preview mode?
    • How do marketing preferences work with Mechanic?
    • Can I send data to Google Sheets?
    • What's possible with timeline comments?
    • I'm getting a "query param length is too long" error when using GraphQL.
    • Can my Mechanic concurrency limit be raised?
    • What IP address does Mechanic use?
    • Can Mechanic read or manage customer subscriptions?
    • Why is everything harder now?
    • Can task content be translated into multiple languages?
    • Can I add a time delay to my task?
    • Can I add another store to my existing Mechanic subscription?
    • How can I reduce memory usage of my task?
    • How do I connect PayPal to Shopify with Mechanic?
    • How do I add a Shopify access scope to my task?
    • Can I have my Mechanic data retained for more (or less) than 15 days?
Powered by GitBook

Important Updates

  • đŸ“Ŗ Shopify REST Deprecation
On this page
  • Mechanic
  • Actions
  • Emails
  • Errors
  • Scheduler
  • User
  • Shopify
  • User
  • Third-party
  • Appstle Subscriptions
  • Judge.me
  • Locksmith
  • Report Toaster
  • Additional apps

Was this helpful?

Edit on GitHub
Export as PDF
  1. Platform
  2. Events

Event topics

A complete index

PreviousEventsNextEvent filters

Last updated 2 days ago

Was this helpful?

Mechanic supports a variety of , each a classification of an . Each can signal its interest in specific topics by using .

This page is a complete index of pre-defined topics, organized by the event topic's domain.

Incoming events may be selectively filtered out using .

Mechanic

Actions

  • 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.

Emails

  • 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.)

Errors

Learn more about .

  • 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.

Scheduler

  • 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.

User

  • 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

Shopify

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.

For a description of each topic's behavior, see Shopify's documentation:

  • shopify/carts/create

  • shopify/carts/update

  • shopify/channels/delete

  • shopify/checkout_and_accounts_configurations/update

  • 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/finance_app_staff_member/delete

  • shopify/finance_app_staff_member/grant

  • shopify/finance_app_staff_member/revoke

  • shopify/finance_app_staff_member/update

  • shopify/finance_kyc_information/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/markets_backup_region/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

User

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:

Third-party

Appstle Subscriptions

  • 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.

Judge.me

Locksmith

Report Toaster

Additional apps

More specific times can be achieved by subscribing to an event topic with a delay (e.g. "mechanic/scheduler/daily+5.hours"). There is no limit to the length of the delay, including delaying longer than the scheduler interval itself (e.g. "mechanic/scheduler/daily+100.hours"). To learn more, see .

Not to be confused with events in the User domain, the mechanic/user event subject describes ways that the user expresses their intent – to Mechanic – to run the task. are available for these topics.

mechanic/user/form When used, adds a "Run task" button to the task itself. When Run Task button is clicked they are presented with form that contains any that have the _userform flag. 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.

The following mechanic/user topics are typically used with , and are documented there more fully.

These events are generated by Shopify webhooks, and are automatically configured for you by Mechanic. Tasks subscribing to Shopify events receive , containing data from the webhook.

The can be used with any User event topic

may be configured to generate events using any User event topic

Learn more about the Appstle Subscriptions integration .

judgeme/review/created — Occurs when new Judge.me reviews are received. Requires enabling the Mechanic integration within Judge.me; see .

judgeme/review/updated — Occurs when Judge.me reviews are updated. Requires enabling the Mechanic integration within Judge.me; see .

locksmith/sessions/ping — Occurs when a user gains access to a resource on an online store using . Learn more .

report_toaster/reports/create — Occurs when a Report Toaster report has been created and is available for download. Learn more .

report_toaster/reports/fail — Occurs when a requested Report Toaster report has failed. Learn more .

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 .

Third-party services can often be connected to Mechanic using .

event topics
event
task
subscriptions
event filters
error handling
Subscriptions
Run links
task options
Shopify admin action links
Liquid environment variables
https://shopify.dev/docs/api/webhooks
Event action
Webhooks
here
Judge.me's integration announcement
Judge.me's integration announcement
team@usemechanic.com
webhooks
Locksmith
here
here
here