Magento Help & Support

Supported Triggers#

• New Sales Order Invoice - Triggers when Magento gets a new sales order invoice.
• New Sales Order Credit Memo - Triggers when Magento gets a new sales order credit memo.
• New Sales Order Shipment - Triggers when Magento gets a new sales order shipment (with line item support).
• New Customer - Triggers when Magento gets a new customer.
• New Sales Order Shipment - Triggers when Magento gets a new sales order shipment.
• New Order - Triggers when Magento gets a new order.
• New Product - Triggers when a new product is created in Magento.
• New Sales Order Invoice - Triggers when Magento gets a new sales order invoice (with line item support).
• New Order - Triggers when Magento gets a new order (with line item support).

Supported Actions#

• Create Customer - Create a new customer
• Create Category - Create a new category
• Create Product - Create a new catalog product
• Create Sales Order Comment - Create a new sales order comment
• Create Invoice - Create a new invoice for an order

Getting Magento working with Zapier takes a few steps but luckily its just a bunch of clicks! Once you start with Zapier we'll eventually ask you to connect your Magento Account to Zapier, it will look something like this:

The first part is just a single popup asking for some more information. The top field is just a label that helps you identify which Account is which (this is very helpful if you manage multiple Magento installations!). The label doesn't have any affect on the actually connection.

The other three fields simply give us the information to get started. The full domain could be as simple as http://example.com/ or http://example.com/store/ or http://example.com/store/index.php/. Basically, wherever you'd login as the admin will have the correct domain at the beginning.

For example, if your admin login page is http://beesandbeads.com/magento/index.php/admin/ then you should use http://beesandbeads.com/magento/index.php/!

How to get your Magento API key#

The user and API key needs to be created by hand! More information if you read more below.

You'll need to create two things before you can give Zapier permission to access your Magento installation:

1. A SOAP/XML-RPC Role.
2. A SOAP/XML-RPC User.

You can find them by logging in and inspecting your navigation bar.

If you continue on to create a SOAP/XML-RPC Role (your first step), just give it a handy name that you'll remember later!

On the left, choose Role Resources and select All from the drop down.

Pro tip: if you'd like to give more granular data you can select custom resource access one-by-one! This takes longer and is more complicated, so we recommend skipping that for now!

On the far right, click Save Role.

Now go back to the menu and create a new SOAP/XML-RPC User and give it some information, we like to use a standard username (so it is easy to remember) and use an application like this to generate secure API keys. Keep that code around, you'll need it in a second!

On the left, chose User Roles and select the SOAP/XML-RPC Role you made earlier.

On the far right, click Save User.

Finally, just enter the User and API key from the last step into the popup! Click continue.

Great job! Zapier should now test your Account to double check that the connection is in good shape! You can now continue creating your Zap.

Fault (code 630) occurred. Message: Unable to read request#

You might have entered http://example.com/ but you should try http://example.com/index.php/ instead!

Fault (code 623) occurred. Message: Calling parameters do not match signature#

This error means that something was not configured correctly when Magento was installed. The easiest fix is to edit /lib/Zend/XmlRpc/Server.php in your Magento folder by commenting out a particular line of code.

Before:

After:

Parsing Errors (Expat, Document, or Element)#

This could be caused by a number of things! The basic gist of it is: "We couldn't make sense of the response from your server."

One common issue is URL rewriting. If your Apache or Nginx instance is a bit overzealous it could be just trying to send you back to the homepage or even serving up a 404 or 200 HTTP response full of HTML we don't understand.

On occasion your server running Magento will be misconfigured and return various error messages or log message. These errors can poison the XML payload to Zapier leading to errors. One quick fix is to add error_reporting(0); to your index.php or the file /lib/Zend/XmlRpc/Server.php found within your public HTML folder.

My Magento trigger is triggering slowly#

In order to ensure that we only trigger on new items that have complete information, your zap will make sure that a new item shows up with the same info in consecutive checks for new data. This can result in zaps triggering on new items more slowly.

Other Miscellaneous Errors#

Sometimes Magento has a hard time resetting after you make large changes, so we recommend flushing your cache. Just go to the proper Cache Management screen in the System menu:

And click "Flush Magento Cache" in the top right:

My Version of Magento is not Supported#

Zapier utilizes the XML-RPC v1 API of Magento. This configuration is available within all versions of Magento, including Enterprise, Go, and Community.

To check if your site is setup correctly for XML-RPC v1, visit http://your-website.com/api/xmlrpc/ (replacing your-website with your actual domain). If you get back XML data that looks like the following, then you should be ready to connect to Zapier.