Overview

Zapier is a popular, easy-to-use service that lets you to integrate more than 1,500 apps using a point-and-click interface - no programming required. The CYPHER Learning app on Zapier allows you to connect your portal with these apps to automate workflows and share data between systems.  

The integrations allows you to trigger actions that create accounts, enroll users in courses, and more.  

Installing and configuring a Zapier integration

To start using Zapier, the app must be installed. To install the Zapier app:

1. Click Admin from the primary navigation menu.
   
2. Click App center from the fly-out menu.
   
3. Click Install on the Zapier app in the Integration tools section.

1. Click Admin from the primary navigation menu.
   
2. Click Zapier from the fly-out menu.
   
3. Select the events you would like sent to Zapier.
   

Note that your Portal ID is listed on this page. You will need your Portal ID when connecting your Zapier and CYPHER accounts.

You will also need an API Key for the integration.

To set up an API Key for Zapier:

1. Click Admin from the primary navigation menu.
   
2. Click API from the fly-out menu.
   
1. If API does not display in the fly-out menu, you must first install the API app from the App center.
   
3. Click Add.
   

Note that an API key can only be added by a Super administrator.

The Add pop-up displays.

1. Enter a name for the key (such as Zapier).
   
2. Select Version 3.0.
   
3. Click Save.
   

The key will be automatically generated and displayed as the Secret key. You will enter the alphanumeric key as the API Key for the Zapier integration.

Note that in the screenshot below, the Secret key has been hidden.   

Connecting accounts

1. Log into your Zapier account.
   
2. Click App Connections from the side bar menu.
   
3. Click Add Connection.

The Add new connection pop-up displays.

1. Enter Cypher Learning in the search box.
   
2. Click on the CYPHER Learning search result.
   

A pop-up displays asking if you will allow Zapier to access your CYPHER Learning account. 

1. Enter the API Key you generated for Zapier in the previous steps.
   
2. Enter the Portal ID.
   
1. The Portal ID can be accessed on your CYPHER Learning platform on the Admin > Zapier page. The Portal ID displays at the bottom of the Events tab.
3. Select your API Host.
   
1. Business platforms select MATRIX LMS.
   
1. AU based customers select MATRIX LMS AU.
   
2. EU based customers select MATRIX LMS EU.
2. Academia platforms select NEO LMS. 
   
1. AU based customers select NEO LMS AU.
   
2. EU based customers select NEO LMS EU.

1. Click Yes, Continue to CYPHER Learning.
   

Your account will be connected and you can start creating zaps.

Creating Zaps: Triggers

A Zap in Zapier is an automated workflow that connects two or more apps so they can perform tasks automatically.

1. A Trigger is an event that starts the automation. The Trigger may originiate in your CYPHER Learning platform, or it may originate in another platform.
   
2. An Action is what Zapier does automatically when the trigger happens. 
   

1. Log into your Zapier account.
   
2. Click App Connections from the side bar menu.
   
3. Click Create.
4. Click Zaps.

1. Search for the app that will start the workflow.
   
2. Select a trigger that will start the workflow. These are the triggers you can choose from for CYPHER Learning:
   
1. Learner Unenrolled From Course: Triggers when a learner is unenrolled from a course.
   
2. Learner Completed Course: Triggers when a learner completes a course.
   
3. Learner Enrolled in Course: Triggers when a learner enrolls in a course.
   
4. User Was Added to Portal: Triggers when a new user is added to the portal. Carries all the information related to the added user, including the User ID, which is needed in the Unenroll, Deactivate and Reactivate actions
   
5. Order Payment Was Made: Triggers when the checkout process is completed. It will also trigger if there was a problem during checkout (or a cancellation) in the case of gateways with off-site processing, such as PayPal or PayUbiz. 
   
6. Subscription Payment Was Made: Triggers when a subscription payment was made or was attempted. The first payment will always be made when a subscription is purchased and the checkout is successful. Afterward, payments will be made based on the subscription setup (yearly or monthly). 
   
3. Select a Value for the trigger.
   
1. In the example below, the trigger Learner was Unenrolled from Course was selected, so a Course must be selected.
   
4. The first 100 results are loaded. If the value you are looking for does not display, click Load more.

The Select value for Course pop-up displays.

1. Search for the course.
   
1. If the course does not display, you may need to enter the Course ID.

1. Enter the Course ID.
   
2. Select the course radio button.

To find the Course ID:

1. Access the course in your CYPHER Learning platform.
   
2. Locate the Course ID in the URL of the course.
   

Creating Zaps: Actions

After setting up the Trigger, you will add an action.

If you set up a Zap that originates with a Shopify trigger, please note the CYPHER Learning Zapier app has been configured to look for the course ID in the SKU field of the product. When adding/editing a product you will see the SKU field, where you will enter the course ID.

General action

When connecting with eCommerce platforms other than Shopify, you can use the general action, together with Zapier's filtering functionality. When using the Add User, Then Enroll to Course (General) action, you have to choose the course ID where the new user will be enrolled. This means you have to create a new Zap for each course you are selling.

After setting up the eCommerce trigger, you must add a Filter which checks the existence of a unique identifier of the course (like the name, SKU, or anothercustom field), so this Zap only runs when that specific course is purchased.

General action example: WooCommerce

Below is an example a ZAP using a WooCommerce trigger. To set up the ZAP:

1. Connect WooCommerce to Zapier.
   
2. Create a Zap.
3. Configure the WooCommerce trigger.
   
4. Add a Filter:
   
1. Click on the + icon after the trigger, which will display the following text on hover: Add a Filter or an Action.
   
2. Click Filter.
   
3. For the first dropdown select Line Items, for the second one select (Text) Contains.
   
4. Then in the text field, enter the unique identifier for the course, for example, the Course name.
   
5. Click continue and Zapier will test the filter with the latest test data for this action.
   
1. Please note that it's possible the filter won't find the search text during the test because it uses standardized test information from Zapier.
   

Locating the Course ID

For auto-enrollment to work, Zapier needs to know the course ID from the CYPHER Learning database. The Course ID can be found at the end of a course's URL.

1. For example, in the course URL https://myschool.matrixlms.com/teacher_custom/show/26360, the course ID is 26360.

Zapier widget

The platform also includes a Zapier widget, which administrators can add to the Admin dashboard.

To add the widget to the Admin dashboard:

1. Click Home from the primary navigation menu.
   
2. Click the Admin tab.
   
3. Click the Edit widgets icon.
   

The Edit pop-up displays.

1. Click Center panel.
   

In Edit mode:

1. Drag the Zapier widget from the Available widgets column to the Center panel.
   
2. Click Save. 
   

The widget displays the number of Zapier calls and the number of errors that occur by date.