# Get started

[Zapier](https://zapier.com) is a fantastic tool for building custom workflows when certain things happen on Synap and it lets you link up all your different tools to Synap. For example, using Zapier you can set up the following automations:

* **When** user registers an account on Synap -> **Then** add row to Google Sheets
* **When** user completes an attempt on Synap -> **Then** send email
* **When** user purchases a product on Shopify -> **Then** add / invite to a user group on Synap

Synap's Zapier intergatrion is now pubclic so you can search for it in Zapier.  If you want to use our Zapier integration, please get in touch via the Chat widget on your portal and we will help you get your Synap and Zapier accounts linked up.

{% hint style="info" %}
🧠 The same workflows can be achieved using Synap's API endpoints, see our [API Documentation](https://documenter.getpostman.com/view/12589621/TVep8T7E) for more details
{% endhint %}

### Actions and Triggers summary

<details>

<summary>🔫 Triggers -  <a href="/pages/QgaXgThIKmKknJvGl0AG">Go to Triggers article</a></summary>

* Completed Assignment
* Completed Attempt
* User Registered
* Store Purchase
* Flag Planted
* User Added to User Group
* User Registered for Exam
* Completed Exam
* Submitted Attempt
* Submitted Exam
* User Updated

</details>

<details>

<summary>🎬 Actions - <a href="/pages/HgmxMIsjxssVce7s66zz">Go to Actions article</a></summary>

* Invite User&#x20;
* Add User to User Group
* Remove User From User Group
* Add Study Item to User's Study
* Remove Study Item From Users's Study&#x20;
* Create User&#x20;
* Update User&#x20;
* Get Attempt&#x20;
* Get User by ID
* Get User by Email

</details>

### 🚗 Getting started with Zapier

To use on Synap's Zapier, ask your account manager for your credentials, and they will send you:&#x20;

* Portal ID
* Secret Key

<figure><img src="/files/92b0T1QMxq0VWqinyV13" alt=""><figcaption><p>Enter your Portal ID and Secret Key</p></figcaption></figure>

Once you have all of the above you'll be able to get started with all of Synap's triggers and actions.

### ⚡️ Creating a Zap

On Zapier create a new Zap and search for 'Synap' and select the latest version available.&#x20;

<figure><img src="/files/J0LelRBuM3qUp66pO1SX" alt=""><figcaption><p>Searching and selecting the latest Synap version</p></figcaption></figure>

Select the trigger you wish to use and click 'continue' You may need to connect your account using the credentials provided by your account manager.

<figure><img src="/files/Xb2UIJFONl92OXzsPxx0" alt=""><figcaption><p>Selecting Synap and searching our custom triggers</p></figcaption></figure>

Click 'Continue' and then you can test the trigger! Doing this will pull through any data from the last few minutes relating to your chosen trigger.

{% hint style="danger" %}
🚨 Testing Triggers will require a recent event of that type (3 minutes), you can skip this step.
{% endhint %}

For setting up actions simply follow the same steps just ensure you aren't doing it in the first box that Zapier offers you, it should look like this.&#x20;

* Completed attempt&#x20;
* User registered
* Store purchased - When a user purchases from your Synap store, if you are using a  Shopify/Woo commerce store e.t.c  they provide their own triggers.
* Completed assignment&#x20;
* Flag planted
* User added to user group
* User registered for exam
* Completed exam
* User updated (email, name or user attributes changed)

**Create actions**

* Invite user
* Add user to user group
* Remove user from user group
* Add study item to user's study
* Remove study item from user's study
* Create user&#x20;
* Update user
* Get attempt

**Search actions**

* Get User by Email
* Get User by ID

<figure><img src="/files/QI0DlCcAG5Jee9Rd2n7g" alt=""><figcaption><p>Selecting Synap and searching our custom actions</p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/integrations/zapier/get-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
