Using Magento 2 actions in action flows

Before you can include external actions in your action flows, you must connect the action builder to the external system.

What's my plan?

All Suites

Team, Growth, Professional, Enterprise, or Enterprise Plus

Support

Team, Professional, or Enterprise

Summary: ◀▼

Connect action builder to Magento 2 to add external actions in automated workflows. You can search or look up customers, orders, products, invoices, and shipments, or create customers, using a Magento 2 integration token and the right permissions. Use a service account and review access scopes to keep your connection and data access controlled.

By connecting the action builder to external systems, such as Magento 2, admins can integrate Zendesk with external systems in automated workflows, improving collaboration and maintaining a seamless experience across multiple platforms.

Note: The steps associated with external systems in action flows are referred to collectively as external actions.

This article contains the following topics:

• Connecting Magento 2 to action builder
• Using Magento 2 actions in action flows

Connecting Magento 2 to action builder

Before you can include external actions in your action flows, you must connect the action builder to the external system.

When connecting to external systems for use in action flows, the following best practices are recommended:

• All external actions performed by an action flow are attributed to the user who connected the external system. Therefore, it's a best practice to use a dedicated service account rather than personal credentials when connecting to each external system.
• All integrations request access to necessary scopes. However, it's important that you review and validate the scopes before authorizing the connection to the external system.
• When managing credentials for API key-based tools, such as OpenAI, it's best to store keys in a secure vault or credential manager.

The Magento 2 connection requires the following authentication information:

• Magento 2 host: Your Magento 2 or Adobe Commerce domain (for example, mystore.com). Enter only the domain without the https:// prefix or trailing path.

• Store code (optional): The store view code used in API URLs. Use "default" for a single-store setup. This is configured in Magento 2 Admin under Stores > All Stores.

• Integration access token: The access token issued to a Magento 2 integration. This token is sent as a Bearer token in API requests.

To create an integration token

Ensure your Magento 2 integration has permissions for all resources you plan to access through action flows.

1. In Magento 2 Admin, navigate to System > Integrations.
2. Create a new integration or activate an existing one.
3. Ensure the integration has the required resource scopes for Customers, Orders, Products, Invoices, and Shipments.
4. Copy the access token provided after activation.

To connect action builder to Magento 2

1. In Admin Center, click Apps and integrations in the sidebar, then select Actions > Action flows.
2. Create or edit an action flow.
3. Open the step sidebar.
4. Under External actions, click Magento 2.
5. Click Connect.
6. Follow Magento 2's prompts to enter your Magento 2 integration token and complete the connection.
   Note: All external actions performed by an action flow are attributed to the user who connected the external system. Therefore, it is a best practice to use a dedicated service account rather than personal credentials when connecting to each external system.

After you've connected to the system, you'll see an indicator that it's connected and details about the instance you're connected to, as well as the actions available for Magento 2.

Using Magento 2 actions in action flows

The following Magento 2 actions are available:

• Search customers
• Lookup customer
• Create customer
• Search orders
• Lookup order
• Search products
• Lookup product
• Lookup invoice
• Search invoices
• Lookup shipment

Searching customers

Use the Search customers action to find customer accounts in Magento 2 based on search criteria such as email, name, or customer ID.

This action has the following inputs and outputs:

	Variables
Inputs	Optional: Search criteria and filters
Output	Array of customer objects containing customer details including ID, email, name, addresses, and account information.

Looking up a customer

Use the Lookup customer action to retrieve detailed information about a specific Magento 2 customer account by customer ID.

This action has the following inputs and outputs:

	Variables
Inputs	Required: Customer ID
Output	Customer details including ID, email, first name, last name, addresses, group information, account creation date, and custom attributes.

Creating a customer

Use the Create customer action to create a new customer account in Magento 2 with contact information and optional address details.

This action has the following inputs and outputs:

	Variables
Inputs	Required: Email, First name, Last Name Optional: Middle name, Name prefix, Name suffix, and address fields
Output	Created customer details including ID, email, name, account status, and creation timestamp.

Searching orders

Use the Search orders action to find orders in Magento 2 based on search criteria such as order number, customer email, status, or date range.

This action has the following inputs and outputs:

	Variables
Inputs	Optional: Search criteria and filters for order status, customer, dates, and order attributes
Output	Array of order objects containing order details including order ID, increment ID, status, customer information, totals, and timestamps.

Looking up an order

Use the Lookup order action to retrieve detailed information about a specific Magento 2 order by order ID or increment ID.

This action has the following inputs and outputs:

	Variables
Inputs	Required: Order ID or Increment ID
Output	Order details including ID, status, customer information, billing and shipping addresses, items, payment information, totals, and timestamps.

Searching products

Use the Search products action to find products in your Magento 2 catalog based on search criteria such as SKU, name, type, or attributes.

This action has the following inputs and outputs:

	Variables
Inputs	Optional: Search criteria and filters for product attributes, SKU, name, type, and status
Output	Array of product objects containing product details including ID, SKU, name, type, price, status, and attributes.

Looking up a product

Use the Lookup product action to retrieve detailed information about a specific Magento 2 product by SKU or product ID.

This action has the following inputs and outputs:

	Variables
Inputs	Required: Product SKU or product ID
Output	Product details including ID, SKU, name, type, price, status, weight, visibility, category links, stock information, and custom attributes.

Looking up an invoice

Use the Lookup invoice action to retrieve detailed information about a specific Magento 2 invoice by invoice ID.

This action has the following inputs and outputs:

	Variables
Inputs	Required: Invoice ID
Output	Invoice details including invoice ID, order ID, state, billing and shipping addresses, items, totals, and creation timestamp.

Searching invoices

Use the Search invoices action to find invoices in Magento 2 based on search criteria such as order ID, customer information, or invoice status.

This action has the following inputs and outputs:

	Variables
Inputs	Optional: Search criteria and filters for invoice status, order, customer, and dates
Output	Array of invoice objects containing invoice details including ID, order reference, state, totals, and timestamps.

Looking up shipment

Use the Lookup shipment action to retrieve detailed information about a specific Magento 2 shipment by shipment ID.

This action has the following inputs and outputs:

	Variables
Inputs	Required: Shipment ID
Output	Shipment details including shipment ID, order ID, store information, shipping address, items, tracking information, and creation timestamp.