# Zapier Integration

## What is it?
Zapier is an app automation platform where users can connect apps into customized workflows—what they call "Zaps". A Zapier integration can connect Rake's API to the Zapier platform and let it integrate with 2,000+ other popular apps to watch for new or updated data, find existing data, or create and update data.

https://platform.zapier.com/quickstart/introduction

## MVP for Zapier integration
> We should target the Partnership program outlined here, at the end of this project we would want to be ready to apply for Zapier partnership. https://zapier.com/developer/documentation/v2/lifecycle-launch/

1. In Admin Console, we should add an Integrations page.
3. That page will have a section for "Direct Integrations", which we can currently fill with other integrations like Google My Business , etc.
4. And a second tab in same area for "Using Zapier". See https://platform.zapier.com/partner_api/embedding
5. In the "Using Zapier" tab, we want to have a way for Rake admin console users to create Zaps directly from within Rake.
6. We should have ten (10) Zap Templates ready for common Zaps (these are TBD). But they would allow users to openly create a new Zap for any Rake event to any supported app via Zapier.
7. Configured Zaps should be listed in their own sub-tab "Configured Zaps", while templates should be in a tab called "Explore Zaps"
8. Example of how ZoHo allows users to add Zaps directly in their app or choose from existing Zap templates. 

## How Zapier Works

1. Authenticate
2. Choose Trigger Events and data
3. Choose Secondary App and Actions

## Developing in Zapier
https://developer.zapier.com/
We will want the developer account we ultimately use to be Rake branded. It's ok to use a personal account at first, but once we get into a place where we are building templates, we will want a common branded account.

## What events will we need to push to other apps?
These are the triggers in Rake that may cause a Zap to fire (if one is actively configured).

### Real-time Event Trigger Examples
These would be "global" event triggers, avaiable at the system level. More may be needed.
>For serious consideration. Do we need to build a UI in Admin Console to allow admins and super users to custom build event triggers for any scenario that will be able to be used by an interface? I'm thinking about any event of combination of events. e.g. A workspace is deactivated, an entity has not had a new session in "X" days, and entity had a session end "X" hours ago, etc. etc. Should some event triggers be "global" or defined for a org/proj/workspace?

#### Internal session events
| Event | Real-time | Data |
| -------- | -------- | -------- |
| New public message posted anywhere | YES | JSON |
| New messages posted to public channel | YES | JSON |
| New Public Channel created | YES | JSON |
| New Private Channel created | YES | JSON |
| New @mention in public channel | YES | JSON |
| New sytemUser joined a public channel | YES | JSON |
| New message posted to private channel | YES | JSON |
| New reaction added to message in public channel | YES | JSON |
| New file uploaded | YES | JSON |

#### External session events
| Event | Real-time | Data |
| -------- | -------- | -------- |
| New external session started (first message received) | YES | JSON |
| New external session ended | YES | JSON |
| Agent assigned to session | YES | JSON |
| Tag added to session | YES | JSON |
| Customer assigned to session | YES | JSON |

#### Visitor monitoring events
| Event | Real-time | Data |
| -------- | -------- | -------- |
| New visitor web session ended | YES | JSON |
| Invitation sent to visitor | YES | JSON |

#### Task Events
| Event | Real-time | Data |
| -------- | -------- | -------- |
| New Task created | YES | JSON |
| Task updated | YES | JSON |
| Task deleted | YES | JSON |
| File posted to task | YES | JSON |
| Note added to task | YES | JSON |

#### Entity (Customer) Events
| Event | Real-time | Data |
| -------- | -------- | -------- |
| New Customer created | YES | JSON |
| Customer updated | YES | JSON |
| Customer merged | YES | JSON |

#### SystemUser Events
| Event | Real-time | Data |
| -------- | -------- | -------- |
| SystemUser Added | YES | JSON |
| SystemUser Updated | YES | JSON |

### Cron-based Event Trigger Examples
These would be triggers encountered by a cron-job that runs hourly/daily/weekly, etc.

#### Internal session events
| Event | Real-time | Data |
| -------- | -------- | -------- |
| Session Ended [hours] ago | NO | JSON |
| Task due [hours] from now | NO | JSON |
| No message activity for [days] in workspace | NO | JSON |

## What actions will be available for events pushed to us from other apps?
These are usually Create or Search actions.
### Creates
| Event | Real-time | Data |
| -------- | -------- | -------- |
| Send Channel Message | YES | JSON |
| Send Direct Message | YES | JSON |
| Add Reminder (coming soon) | YES | JSON |
| Set Channel Topic (feature coming soon) | YES | JSON |
| Send Private Channel message | YES | JSON |
| Create Channel | YES | JSON |
| Invite SystemUser | YES | JSON |
| Update SystemUser Profile | YES | JSON |
| Create a Task | YES | JSON |
| Update a Task | YES | JSON |
| Delete a Task | YES | JSON |
| Add a file to a Task | YES | JSON |
| Add a Note to a Task | YES | JSON |
| Add a new Entity (customer) | YES | JSON |
| Update Entity data (customer) | YES | JSON |

### Searches
Data available through Rake Search
| Event | Real-time | Data |
| -------- | -------- | -------- |
| Find a message | YES | JSON |
| Find systemUser by email | YES | JSON |
| Find systemUser by name | YES | JSON |
| Find systemUser by Id | YES | JSON |
| Find a Task by Name| YES | JSON |
| Find a Task by Id| YES | JSON |
| Find a Task by Customer| YES | JSON |
| Find a Task by assigned systemUser| YES | JSON |
| Find an entity (customer) | YES | JSON |
| Find sessions by entity (customer) | YES | JSON |

## UI Considerations
Embed via the Partner API vs. Widget.js
> I prefer the Partner API as it allows us to have control over the UI, such as Unbounce did here.
>