# Overview
YellowAnt is a workplace assistant bot that lets you manage and automate your work. YellowAnt is available as a standalone web application and as a bot on Slack and Microsoft Teams. It connects with your workplace applications like Task Management, Email, Calendar, Cloud Storage, Code Repositories, Application and Server monitoring, Incident Management, CI/CD and most DevOps tools and gets you real time updates from all your apps. These updates also come with interactive action buttons and action forms, so that you can take immediate actions whenever you get an alert.
Since YellowAnt is connected to all your apps, you can create cross application workflows that can be triggered by a YellowAnt command or a background event from one of your apps. These powerful workflows ultimately let you automate a significant chunk of your tasks and take actions with incredible speed thereby reducing your response time to critical events.
Head over to [www.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/www.yellowant.com) to sign up now!
# How to Signup
YellowAnt accounts exist within teams. All individuals in the team creates their own account within the YellowAnt team.
There are three ways to sign up on YellowAnt:
* Using Slack
* Using Microsoft Teams (Coming Soon)
* Using Email
This is covered in detail in their respective sections.
**How do YellowAnt teams work?**
Let's take an example.\
A member of team ACME is signing up on YellowAnt for the first time. He creates a team called acme-team on YellowAnt. The URL for the team is acme-team.yellowant.com and anyone from the same team would be in the same YellowAnt team as well. This is because all YellowAnt accounts (Basic, Premium or Enterprise) are billed at a team level.
The team URL looks like this:
**How does it work when using Slack?**
In a Slack team, when one of the team members signs up on YellowAnt, a new YellowAnt team with the same subdomain is created. Now, whenever a member of that Slack team joins YellowAnt, they are automatically part of the same YellowAnt team. This is because of the same reason i.e. billing takes place at a team level.
For example, the acme-team on slack has a corresponding acme-team on YellowAnt when signing up using Slack.
If Slack team URL is:
Then, YellowAnt team URL would be:
**How does it work when using Microsoft Teams?**
*Coming Soon.*
# Signup with Slack
Slack users can directly signup with their slack accounts by clicking on the “Sign Up with Slack”. After which you will be asked to log in your slack account. If you are already logged in your slack account then it will directly lead you to the authorization page, where after just once click you are good to go.
YellowAnt will create a team account with the same domain name as your Slack domain and makes your Slack Team owner the owner of the YellowAnt team account.
Let's take a look at the step by step process for signing up using Slack:
1. Go to [www.yellowant.com](http://www.yellowant.com) and click on "Sign Up using Slack" or "Sign Up" in the header.
2\. If you clicked on the direct Slack Sign Up button, it takes you to the "Authorization" page and by clicking on the "Sign Up" button in the header, you are taken to a page where you have the option on Slack or Email. Click on "Sign Up with Slack"
3\. Select your team on top right corner and click on "Authorize" once you've read the permissions.
4\. You will be taken to the YellowAnt dashboard where you can start integrating applications.
# Signup with MS Teams
Microsoft Teams users can directly import the YellowAnt bot into a team by adding YellowAnt from the Teams bot marketplace. You will be asked to authorize your Azure account, after which YellowAnt will create a team account(connected to your Office 365 tenant) with the same domain name as your Azure email domain. If you are the first one from your Office 365 directory to integrate YellowAnt, YellowAnt will make you the owner of the YellowAnt team account - in this case, you will need your Tenant administrator to create an account and transfer the YellowAnt team account.
Let's take a look at the step by step process for signing up using Teams:
1. Let us first add YellowAnt to a team. Go to Microsoft Teams, and click on the \[**...]** button next to your Team name in the sidebar. (**Note:** If YellowAnt is already added to a Team, simply go to **Chat sidebar tab,** and search for **YellowAnt** and add it. Start a conversation with YellowAnt by typing **- help.** YellowAnt will send you an authentication message. Go directly to Step 6.)
2. Click on **Manage Team**
3. Click on the **Bot** tab. In the tab, click on **Discover Bots.** Search for **YellowAnt**, and click on the plus**(+)** sign next to the YellowAnt bot
4\. Review the permissions and click on **Add**
5\. Once the YellowAnt bot is added to the Team, YellowAnt will send you a personal message asking you to authorize your Azure account.
6\. Click on **Authenticate** and authenticate your Azure account
7\. You will be taken to the YellowAnt dashboard where you can start integrating applications.
8\. Go back to **Microsoft Teams** and you will have received a help message to get you started.
9\. Let's take YellowAnt for a spin! YellowAnt comes with three pre-built integrations - Stackexchange, WIkipedia and RSS
(i) Go to **Chats** and click on **YellowAnt.**
(ii) Type **wikipedia**
(iii) YellowAnt will show you all commands associated with Wikipedia
(iii) Under **Fetch summary of article,** click on **Run this command**
(iv)YellowAnt will expand the panel and ask for inputs, in this case, the title of the article. Let's put in **Microsoft Teams**
10\. Click on **Submit** to execute the command
11\. YellowAnt will fetch the summary of the title we entered, ie, **Microsoft!**
12\. That is it! This demo is just the tip of the iceberg. You can similarly command from over 35+ applications(See [Integrating Applications](/integrating-applications)), get real time work updates and also create workflows between different applications(See [Command Workflows](/workflows/command-workflows) and [Event Workflows](/workflows/event-workflows)**)**
# Signup with Email
If you are an individual and do not have a team name, create a new team name and then enter your email id in the subsequent tab. An individual can later add new team members.
If you are in a team, enter your team name and your own email id and signup. This creates a new team wherein new team members can be invited and added.
Once you enter your team name and email id, your first step of registration in completed.
Now for the final step, you need to go to your registered email account and click on “Finish Registration” in the “Complete Registration” email sent to you by YellowAnt. This will lead you to a page wherein after you fill your personal details and create a user id, you are done!
Let's take a look at the step by step process for signing up using Email:
1. Go to [www.yellowant.com](http://www.yellowant.com) and click on "Sign Up using E-Mail" or "Sign Up" in the header.
2\. You are taken to a page where you have the option on Slack or Non-Slack teams. You need to enter a custom team name that is going to be your YellowAnt Team Name and your Email. Then click "Join".
3\. A confirmation mail is sent on the registering Email ID.
4\. Click on the confirmation link which will take you to a form where you can create your account filling your details: name and password. EMail and Team are already filled in based on the previous information.
5\. Click on "Start Using YellowAnt" and you will be taken to the YellowAnt dashboard where you can start integrating applications.
# Inviting Team Members
You can also join an existing team using invitation link sent to you by a team member who already uses YellowAnt. Just click on the link and then you will need to go to your registered email account and click on “Finish Registration” in the “Complete Registration” email sent to you by YellowAnt. This will lead you to a page wherein after you fill your details and create a user id, you are ready to use YellowAnt.
Let's look at the process to invite a team member,
1. Go to the settings panel in the YellowAnt dashboard (Read more about the Dashboard)
2\. Open "Admin" settings and go to "Team Members" section and fill in the invites' email ids and click "Invite"
# Managing Dashboard
## YellowAnt Dashboard
YellowAnt Dashboard is the control center of your account. All your settings are available inside the dashboard. You can add new applications, control existing ones and change the settings for them.
## Overview
The overview panel of the YellowAnt dashboard gives you a summary of all your applications and workflows. It is divided into three sections:
**Applications**
In the application section you can see your integrated application along with a few available applications as well.
**Command Workflows**
The command workflow section shows all your command controlled workflows being used as well as the template that are available to you from the Marketplace.
**Event Workflows**
The event workflow section shows all your event triggered workflows being used as well as the template that are available to you from the Marketplace.
Y*ellowAnt Dashboard - Your Personal Control Center*
# Applications
ote: An application on YellowAnt is a connection to an account on an external service with functionalities usable through YellowAnt commands and workflows.
The application panel of the YellowAnt dashboard is the control center for all your integrations.
It is divided into two sections -
**Your Applications**
This section contains all the applications that are already integrated with your YellowAnt account. The integrated applications' cards will have a button called 'Manage' which you can click to enter the settings page of that particular application.
* Change the application invoke name\
The invoke name is used to call apps with commands. For example, the default invoke name for GMail is 'gmail' and to send a mail, you must execute the command 'gmail send'. If you change the invoke name from 'gmail' to 'email', the corresponding send mail command becomes 'email send'.
* Change notifications settings\
YellowAnt subscribes you to a number of notification for each account of that application. If you don't wish to receive those notifications you can change them individually from here.
*YellowAnt Application Management Center - Change invoke names and notification settings*.
**Available Applications**
This section contains all the applications that are available as YellowAnt integrations. The application cards have a button called 'Integrate' which on clicking takes you to the integration page of the application. Start integrating applications.
*YellowAnt Applications Panel in the Dashboard.*
# Command Workflows
**What is a command workflow?** \
YellowAnt is connected to all your apps so you can create cross application workflows that can be triggered by a YellowAnt command. This means with a simple command you can trigger a chain of events across different apps and even use the subsequent data in the process.
The "Command Workflows" panel of the YellowAnt dashboard is the control center for all your command workflows in use. It is divided into two sections -
**Your Workflows**
This contains all the workflows that you are currently using. You can go to the workflow management page by clicking on the "manage" button on your workflow cards. In the management tab you can edit the workflow or make other required settings changes.
**Available Workflows**
This contains all the workflows that are available as templates in the YellowAnt Marketplace. You can click on "Use Template" button on these cards to see what they contain in a detailed overview and proceed to click on the top right button with same "Use Template" again to start editing or using for your needs.
# Event Workflows
**What is an event workflow?** \
YellowAnt is connected to all your apps so you can create cross application workflows that can be triggered by an event of any application. This means a certain event of a certain application can trigger a chain of events across other apps and even use the subsequent data in the process. The "Event Workflows" panel of the YellowAnt dashboard is the control center for all your event workflows in use.
It is divided into two sections -
**Your Workflows**
This contains all the workflows that you are currently using. You can go to the workflow management page by clicking on the "manage" button on your workflow cards. In the management tab you can edit the workflow or make other required settings changes.
**Available Workflows**
This contains all the workflows that are available as templates in the YellowAnt Marketplace. You can click on "Use Template" button on these cards to see what they contain in a detailed overview and proceed to click on the top right button with same "Use Template" again to start editing or using for your needs.
# Select Teams
Since you can be a part of multiple teams on YellowAnt, there is an option to switch teams within the dashboard. By default you see only one team name and the "Log Out" button.
If you are logged into multiple teams, you can go ahead and choose the one which you want to switch to. You can log out of YellowAnt at any point by clicking on "Log Out".
# Console
The console is the native iterface that YellowANt provides for people who want to use it for the following purposes:
1. Use it as the command center: In case you are not on any chat platform like Slack and Microsoft Teams, you can still use YellowAnt from this console. You can command apps and execute workflows directly from here.
2. Use it as logs: No matter which chat application you are using, everything you execute and use will be logged in the console as well. You can always go here and segregate a specific application to see what has been executed for that application.
*YellowAnt Console is useful as a standalone web interface and even a logging mechanism.*
# Settings
The settings button in the header panel gives you 3 options:
1. Settings
2. Integrations
3. Admin
## Settings
The settings panel lets you update your profile and account settings. *Note: This is the same as "Edit Profile" in the dashboard's side panel.*
**Profile** \
You can change your name, time zone and nickname from this panel:
**Account** \
Change your password or update global account settings from here:
## Integrations
The "Integrations" button takes you to the application management center for all your integrated applications. On the left panel, you can see all your integrated apps and the corresponding setting page for it. When you click on an application, you enter the settings page of that particular application. You can perform two operations from there:
* Change the application invoke name\
The invoke name is used to call apps with commands. For example, the default invoke name for GMail is 'gmail' and to send a mail, you must execute the command 'gmail send'. If you change the invoke name from 'gmail' to 'email', the corresponding send mail command becomes 'email send'.
* Change notifications settings\
YellowAnt subscribes you to a number of notification for each account of that application. If you don't wish to receive those notifications you can change them individually from here.
*YellowAnt Application Management Center - Change invoke names and notification settings.*
## Admin
The "Admin" panel is only visible to team owners and gives access to a whole lot of actions for administrators to use and cater to the entire team.
Admin Account: Holds the "Team Details" which has the team name. Please note, changing the team name would log out every team member:
Team Members: Holds the list of team members and an option to invite new users by simply adding their email ids:
Payment Methods: This section is used to manage payments for team who are on Basic and Premium plans. The administrator adds a card that is used to pay for YellowAnt:
Billing History: Contains entire billing history of past transactions:
Billing Plan: The panel where the administrator can change the team's YellowAnt plan - Free, Basic or Premium:
# External Links
In the bottom part of the side panel, you will find 3 external links
1. API - Takes you to the YellowAnt API documentation. Find complete listings of all the classes, objects, methods and functions available across all the parts of the YellowAnt API.
2. Developers - Explore what the YellowAnt Developer mode has to offer. Build applications - connect your internal tools and micro-services. Comprehensive API and SDK Documentation along with very easy to use API.
3. Documentation - This link basically takes you to this documentation itself. Access it easy through one click at any point of doubt or query.
# Integrating Applications
YellowAnt Marketplace is the place you find all the available integrations. From everyday apps like GMail, Calendar, Drive, Asana, Trello and DevOps tools like Amazon Web Services, Salesforce, CircleCi, Sentry, AirBrake, NewRelic, Github, Bitbucket and much more. Choose from the categories listed below and explained earlier.
Applications are listed under the YellowAnt Marketplace
# Marketplace and App Categories
YellowAnt is a one size-fits-all platform (more like one-platform-fix-all). It caters to the needs of all kinds of businesses and all the different domains that fall within the company. YellowAnt makes it easy for your teams to decide which apps to choose by segregating them into categories and combinations of apps usually used widely in the industry.
Let's quickly look at how the [YellowAnt Marketplace](https://www.yellowant.com/marketplace/) is laid out for your ease of use:
## **ALL**
You can find all applications that are available in the YellowAnt marketplace under this category. This is the best way to skim through all of them at once and figure out your needs easily.
*Available Apps: Every Application that appears in other categories*
## **Analytics**
YellowAnt supports Google Analytics under the analytics category. Many more applications will be available soon.
*Available Apps: Google Analytics*
## **Communication**
YellowAnt lets you access and control many of the widely used communication tools. You can get updates and take quick actions on those apps.
*Available Apps: Gmail, Calendar, RSS, Twitter, Google Contacts, Intercom*
## **Customer Relationship Management**
CRM tools are extremely useful to Sales, Marketing and Customer Support teams and YellowAnt massively reduces the time wasted on these applications by enabling you to get updates and take quick actions through commands and input boxes.
*Available Apps: Jira, JiraO, Freshdesk, Salesforce, Twitter, Intercom*
## **Developer Tools**
Developers need a lot of applications across product cycles and even post delivery. From code repositories, issue tracking, server monitoring to code management, YellowAnt has you covered fully. Most versatile integrations for valuable products.
*Available Apps: \_Bitbucket, Jira, Github, JiraO, Sentry, Jenkins, Airbrake, CircleCI, New Relic, AWS-CloudWatch*
## **File Management**
Manage your files and search for them across applications like Google Drive and Dropbox. Why leave Slack or your chat window when with one click you have access to a search bar within it. Easy to use - effective and fast.
*Available Apps: Google Drive, Dropbox*
## **Google Apps**
With Google's GSuite used across so many businesses, even YellowAnt has it bundled together under one category.
*Available Apps: Gmail, Calendar, Google Analytics, Google Drive, Google Contacts, YouTube*
## **Marketing**
Marketing can be a tedious domain to work if you're not using the right tools. Why not use the right integrations as well? Control all your marketing needs from within your chat window. From getting insights from analytics to "listening" to your company's mentions on twitter. You can do it all from one control center.
*Available Apps: Google Analytics, Twitter, YouTube, Intercom, Salesforce*
## **Notes**
So many applications to make quick notes. With YellowAnt's Evernote integration, you can easily pull up a dialog box or execute a simple command and make a note of whatever comes up throughout the day during work. You can even search for notes, create to-do lists or take actions on them.
*Available Apps: Evernote*
## **Project Management**
All domains in all businesses require project management tools. YellowAnt connects to all these applications and lets you get constant updates from your project boards and take quick actions along with performing tasks through simple dialog boxes and commands.
*Available Apps: Asana, Trello, Jira, JiraO, Evernote*
## **Sales**
In this domain, staying on top of things and leads is key. There are various applications that bridges the technological gaps in sales and now with YellowAnt, it is possible to save lots of time and manage applications using dialog boxes and commands through chat apps like Slack itself. Assigning tasks and updating regularly is now just a click away, no matter which application you use.
*Available Apps: Salesforce, Freshdesk, Jira, JiraO, Intercom*
## **Server Monitoring**
Businesses and software systems reply heavily on server monitoring to ensure everything is running buttery smooth always. Network engineers and admins have a hectic task of making sure they do the job through many applications. Now, with YellowAnt integrations you can get even quicker updates right into your Slack or other chat apps. You can monitor, assign and even resolve issues right from the chat window without having to switch context.
*Available Apps: New Relic, AWS CloudWatch, CircleCI, Airbrake, Jenkins, Sentry*
## **Social/Fun**
Once in a while at work, we require help or need to take a quick break and hop onto Twitter or YouTube. Now, don't go down the spiral path of being distracted. Need Twitter? Pull up your feeds within Slack and take quick actions - Retweet, Heart or even post your own tweet. Look up a video on YouTube directly from Slack/chat apps or search questions and answers on StackExchange as well. All this with a click, awesome dialog boxes and super simple commands of YellowAnt.
*Available Apps: StackExchange,Twitter, RSS, YouTube*
## **To-do Lists**
For staying on top of things, creating to-do lists forms an important part of the day's beginning and even throughout the day. You can now create lists, pull already existing ones and even update them right from the chat window. YellowAnt makes it all possible with the various to-do app integrations.
*Available Apps: Evernote, Asana*
## **Miscellaneous**
The miscellaneous section has apps like Wikipedia, RSS and few others. Search for an article on Wikipedia through Slack or your chat app and only go to the page if the information seems insufficient. YellowAnt takes care of all your needs with the apps in various categories.
*Available Apps: YouTube, RSS, Wikipedia, StackExchange, Twitter*
## **Building on top of YellowAnt?**
You will also see these two categories:
**Private To You -** Applications build by you and kept private to yourself only. You can use it with YellowAnt, find it in the marketplace but your team members won't see it until you make it "Private to Your Team".
**Private To Your Team -** Applications build by members of your team and kept private to the team only. You can use it with YellowAnt, find it in the marketplace but other YellowAnt users outside your team won't see it until you make it "Public" and it is verified and tested by the YellowAnt Dev Team as well.
# Adding an Integration
*Note: We would use Asana as an example for the comprehensive steps. You can find out how to integrate specific apps on their respective application page in the marketplace.*
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
*YellowAnt Dashboard*
*YellowAnt Marketplace*
2\. If you are in the dashboard, go to the tab called "Applications" and look for "Asana" under available applications. If you have already integrated the application, you will be able to see it under "My Applications".
3\. If you are in the Marketplace you can find Asana under various categories such as **all** and **project management**. You can also search for this application in the search bar.
4\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
At this point, there are two possiblities:\
A. Either the application is a simple OAuth authentication like in Asana or GMail.\
B. Or it might require you to authenticate using API token like in Freshdesk or Jenkins.
Steps 5 and 6 show the scenario A for simple OAuth\
Steps 7 and 8 show the scenario B for an API Token authentication (Freshdesk is used as an example)
5\. A. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Asana OAuth page.
A*dd Account Page for Asana*
*Asana Authentication Page*
6\. Allow the needed permissions and Asana is now integrated with YellowAnt.
7\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the application (here Freshdesk) details page.
8\. Once you fill in the details, the authentication is taken care of, the application would now be integrated with YellowAnt.
# Applications on YellowAnt
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace)
2. If you are in the dashboard, go to the tab called "Applications" and look for the application under available applications. If you have already integrated the application, you will be able to see it under "My Applications".
3. If you are in the Marketplace you can find the application under various categories. You can also search for this application in the search bar.
4. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
5. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the application OAuth page or you may have to do it using API keys for application that don't have or allow OAuth.
6. Allow the needed permissions and the application is now integrated with YellowAnt.
## Note: All applications are individually covered in this section with screens to help you out.
# Airbrake
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplac](https://www.yellowant.com/marketplace)e.
2\. In the search bar, simply look for “Airbrake”, or click on the icon. If you have already integrated the application, you will be able to see it under “My Applications”.
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Airbrake Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the Airbrake User API Key.
*You can find your API Key under settings>permissions in your Airbrake account.*
6\. Copy and paste that API Key in the text field on YellowAnt Integration page.
7\. Airbrake is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Airtable
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, simply look for “Airtable”, or click on the icon. If you have already integrated the application, you will be able to see it under “My Applications”.
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click "add account" which takes you to the Airtable Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the Airtable User API Key.
6\. You can find the API Key for Airtable in your account under the account button in your profile. Copy and paste that API Key in the text field on YellowAnt Integration page.
7\. Airtable is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Alexa
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace). In the search bar, simply look for “Alexa”, or click on the icon. If you have already integrated the application, you will be able to see it under “My Applications”.
2\. Once you find the application either in the dashboard or on the Marketplace click on Integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
3\. You will be redirected to the YellowAntr Alexa Skill on Amazon. Click "Enable".
4\. Enable Alexa Notifications and Save Permissions
5\. Select the team you want to integrate with Alexa
6\. Alexa will now confirm that the YellowAnt skill has been enabled.
7\. The next step is to invoke the skill. Go to your device and say, "Alexa Open Skill". When asked the name of the skill, say "YellowAnt". Alexa will confirm invocation, and you are all set to integrate various notifications from all of your apps with Alexa using workflows from YellowAnt.
# Asana
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, simply look for “Asana”, or click on the icon. If you have already integrated the application, you will be able to see it under “My Applications”.
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Asana OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Asana is now integrated with YellowAnt.
6\. Asana is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# AWS Cloudwatch
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, simply look for “AWS Cloudwatch”, or click on the icon. If you have already integrated the application, you will be able to see it under “My Applications”.
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the AWS Cloudwatch Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for some details of your AWS Cloudwatch Account for authentication.
6\. Fill in the details and hit "SUBMIT". Your screen should look like this:
7\. AWS Cloudwatch is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
8\. To get notifications, follow these steps:
a. Select the "create-webhook"command on slack to get your url for webhook configurations.
b. Alternatively, you will also find the webhook url on your integrations page:
c. The next step is to set up your Cloudwatch alarm. For this, complete the following steps. Go to your SNS dashboard and create a new topic.
d. In the endpoint, past the url we received earlier
e. Click on "create subscription" to find a list of your subscriptions. Refresh this page to confirm.
f. You will get a YellowAnt notification confirming your subscription
g. In your EC2 dashboard, select the topic which you created earlier, and click create alarm.
9\. Your AWS Cloudwatch integration is complete and notifications are now set up!
# Azure DevOps
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, simply look for “Azure DevOps”, or click on the icon. If you have already integrated the application, you will be able to see it under “My Applications”.
3\. Once you find the application either in the dashboard or on the Marketplace click on Integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Azure DevOps OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Give the necessary permissions to finish your integration**.**
6\. Select the name of your organization, and click submit.
7\. Azure DevOps is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
7\. To set up YellowAnt notifications, follow these steps.
**Note for project Admins:** If you have admin permissions, YellowAnt will automatically create your Service Hooks for all projects within your organization for which you have admin access. For new projects, you will have to follow the steps below
**Note for non-admins:** If you do not have admin permissions, please follow the steps below to setup your notifications
(i) Go to the project for which you want webhooks. Then go to Project Settings, Service hooks. You can also use the following url for the same:
[`https://dev.azure.com/{orgName}/{project_name}/_apps/hub/ms.vss-servicehooks-web.manageServiceHooks-project`](https://dev.azure.com/{orgName}/{project_name}/_apps/hub/ms.vss-servicehooks-web.manageServiceHooks-project)
(ii) Add a new Service Hook. Select a trigger.
(iii) In the next step, add the webhook url. The webhook url is: [`https://www.yellowant.com/market/applications/2027/webhook/4323f451-5e2a-47c6-a3d2-a/`](https://www.yellowant.com/market/applications/2027/webhook/4323f451-5e2a-47c6-a3d2-a/)
(iv) Click on 'Test' to see if YellowAnt sends a notification. Click "Finish". Repeat this process for all triggers you want to get notifications for.
(v) Notification Service Hooks are set!
# Bitbucket
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, simply look for "Bitbucket" under available applications. If you have already integrated the application, you will be able to see it under "My Applications"
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
\
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Bitbucket OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Bitbucket is now integrated with YellowAnt.
6\. Bitbucket is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Circle CI
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Circle CI" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click "add account" which takes you to the Circle CI Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the Circle CI User API Key.
6\. You can find the API Key for Circle CI in your account using the following steps given below. Copy and paste that API Key in the text field on YellowAnt Integration page.
(i) Go to User Settings Panel
(ii) Go to Personal API Tokens in User Settings and click on Create New Token
(iii) Give a token name and click "Add API Token"
7\. Once it generates a new API Token, copy it immediately and paste it in the YellowAnt integration page.
8\. Circle CI is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Evernote
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Evernote" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Evernote OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Login to your Evernote account and Evernote is now integrated with YellowAnt.
6\. Evernote is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Freshdesk
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Freshdesk" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click "add account" which takes you to the Freshdesk Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the Freshdesk User API Key and Freshdesk Team URL.
6\. You can find the API Key for Freshdesk in your account under Profile Settings > API. Copy and paste that API Key and Team URL in the text fields on YellowAnt Integration page and hit "SUBMIT". Here, Team URL is private16.freshdesk.com.
7\. Freshdesk is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Github
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Github" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Github OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Github is now integrated with YellowAnt.
6\. Github is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Gmail
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Gmail" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Gmail OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Gmail is now integrated with YellowAnt.
6\. Gmail is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Google Analytics
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. If you are in the dashboard, go to the tab called "Applications" and look for "Google Analytics" under available applications. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4.You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Google Analytics OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Google Analytics is now integrated with YellowAnt.
6\. Google Analytics is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Google Calander
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Google Calendar" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Google Calendar OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Google Calendar is now integrated with YellowAnt.
6\. Google Calendar is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Google Contacts
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar,look for "Google Contacts" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Google Contacts OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Google Contacts is now integrated with YellowAnt.
6\. Google Contacts is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Google Drive
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Google Drive" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Google Drive OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Google Drive is now integrated with YellowAnt.
6\. Google Drive is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# HubSpot
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "HubSpot" under available applications or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the HunSpot Drive OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
6\. Allow the needed permissions and HubSpot is now integrated with YellowAnt.
7\. HubSpot is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Jenkins
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Mark](https://www.yellowant.com/marketplace)etplace
2\. In the search bar, look for "Jenkins" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on Integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click "add account" which takes you to the Jenkins Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the Jenkins User API Key, Jenkins Application URL and Username.
6\. You can find the API Key for Jenkins in your account. Copy and paste that API Key in the text field on YellowAnt Integration page. Here's how to find your API Token:
(i) Go to the account page using your username in the top bar. Click on it.
(ii) Click on configure
(iii) Click on "Show API Token"
(iv) You can see your API key there, you can change it as needed, but make sure to change it on YellowAnt too
7\. Copy your Jenkins API Token, go back to the Jenkins settings page and paste the token in the API Token box. Also make sure your Jenkins server URL is correct.
8\. To configure Webhook notifications and for event workflows, copy the Webhook URL from your Jenkins integration settings page. Go to Jenkins and install the Jenkins Notifications plugin from the Jenkins marketplace.
9\. Go to every job from which you need the build notifications. In the **Notification Endpoints,** in the URL Source->URL section, paste the webhook URL copied from the Jenkins-YellowAnt integration settings page. Click on **Save** to finish your Jenkins integration
# Jira
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Jira"ore simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Jira OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Jira requires you to use your Jira Team URL, Username and Password to authorize YellowAnt to access your data.\
**NOTE: YellowAnt has an application called JiraO which has the same capabilities but with OAuth login.**
6\. Jira is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
7\. To set up webhooks, follow these steps. Please note that only admin can add/change webhooks settings:
(i) Go to Site Admin, Application Settings, then Jira.
(ii) Scroll Down to Advanced Settings, then webhooks. Name your application.
(iii) Get the webhook url from your integrations page
(iv) Select all the issues you want notifications for.
(v) Click "Create". Webhook integration is now complete
# JiraO
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "JiraO" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the JiraO OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Once you click on add account, you are taken to the Jira authentication page of YellowAnt where you have to provide some information. The following are the steps to authenticate Jira.
**You need to be a system administrator of the Jira account to be able to create application link (which integrates Jira with YellowAnt). If your Jira server is already registered with YellowAnt, you can skip to the steps starting from Step 7.** \
\
Note: For this tutorial we will be using a dummy Jira account - ‘private61.atlassian.net’.
(i) To create application link to JIRA, click on settings icon. Select the “Applications” option in the menu.
*Image0A - Settings*
*Image0B - Applications*
(ii) Then under ‘Integrations’ section, click on Application Links. In text box enter ‘ and click on ‘Create new link’.
(iii) A box will appear asking you to verify link and continue.
(iv) Now, fill in the details asked in next dialogue box as shown in Image3. Keep the ‘Consumer Key’ and ‘Shared secret’ confidential. Fill in the following details:
‘Request Token URL’ : ‘
‘Access Token URL’: ‘
‘Authorize URL’: ‘
(v) Click continue.
(vi) In the next dialogue box, enter the following details:
Consumer Key - same as done in the previous step.
Consumer name - ‘Yellowant’.
Now, for the ‘Public Key’ we will head to YellowAnt (at ) and authorize YellowAnt.
(vii) Once you are redirected to settings page, fill in your server name and click ‘GO’.
(viii) Click on ‘Create New Server – Your Server Name’ as shown in Image5\
(ix) Fill in the ‘Consumer Key’ and ‘Shared Secret’ (mentioned as ‘Consumer Secret’) you used in Jira and click ‘Generate SSL Public Key’.\
(x) Copy this ‘Public Key’ generated and head back to Jira where you left off.
(xi) Paste the key in ‘Public Key’ field and click continue.\
Your ‘Application Link’ in Jira is created but you haven’t saved server details in YellowAnt yet.
(xii) Head back to YellowAnt where you left off. Fill in the passphrase.\
Note: You can edit the server details, only if you have the passphrase.
(xiii) Now after notification shows ‘Server details saved’, click on back and fill in the name of server and click ‘GO’.
7\. Click on ‘Integrate with \’ and allow YellowAnt to access Jira.
8\. Now, final step, head back to YellowAnt page and click on the continue button.
9\. JiraO is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# New Relic
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "New Relic" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click "add account" which takes you to the New Relic Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the New Relic User API Key.
6\. You can find the API Key for New Relic in your account. Copy and paste that API Key in the text field on YellowAnt Integration page. Here's how to find your API Token:
(i) Go to your "Account Settings".
(ii) Go to Integrations>API Keys
(iii) Click on "Create REST API key".
(iv) Click on "Show Key" and copy this for YellowAnt's API Key Field.
7\. New Relic is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Outlook Mail
COMING SOON
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Outlook Mail" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Outlook Mail OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
6\. Allow the needed permissions and Outlook Mail is now integrated with YellowAnt.
7\. Outlook Mail is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Pagerduty
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Pagerduty" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click "add account" which takes you to the Pagerduty Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the Pagerduty User API Key, Pagerduty User Email ID.
6\. You can find the API Key for Pagerduty in your account. Copy and paste that API Key in the text field on YellowAnt Integration page. Here's how to find your API Token:
(i) Go to "My Profile" in User Settings.
(ii) Click on the "User Settings" Panel and click on "Create API User Token".
(iii) Give a description and create the token.
(iv) Copy the token and paste on YellowAnt and submit.
7\. Pagerduty is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Pivotal Tracker
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "Pivotal Tracker" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click "add account" which takes you to the Pivotal Tracker Access page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. In this step, YellowAnt asks you for the Pivotal Tracker User API Key, Pivotal Tracker Application URL and Username.
6\. You can find the API Key for Pivotal Tracker in your account. Copy and paste that API Key in the text field on YellowAnt Integration page. Here's how to find your API Token:
(i) Go to your settings button and choose "Profile" there.
(ii) You will reach your settings page and now scroll down to find your API Key.
(iii) Copy and use this API Key for your YellowAnt Authorization.
7\. Pivotal Tracker is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# RSS
NOTE: RSS is integrated as a default application for all users. Only in the event that you have removed this or you need two separate instances of the application do you need to integrate using the below steps. RSS doesn't require your login details.
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "RSS" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
4\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
5\. Since RSS doesn't take any user login, with that simple step, it is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Salesforce
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "Salesforce" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Salesforce OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Salesforce is now integrated with YellowAnt.
6\. Salesforce is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Sentry
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "Sentry" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Sentry OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Sentry is now integrated with YellowAnt.
6\. Sentry is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# ServiceNow
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "ServiceNow" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on Integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the ServiceNow OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions to ServiceNow.
6\. Select "Integrate". YellowAnt will ask you to fill in a few details
To find the values for these fields, follow these steps:
(i) Open Application registry in System OAuth in your ServiceNow Instance. Click on "New" and then "Connect to a third party OAuth Provider"
(ii) Click on Create an OAuth API endpoint for external clients. Enter your application name
(iii) Copy the Client ID and the Client Secret. Set the Access token and Refresh token lifespan to some high value Click on Submit. The redirect URL needs to filled with the value:
7\. Enter the Instance name,Client ID and Client secret which was copied earlier. Click "Allow" in your ServiceNow instance
8\. YellowAnt will send you a message with available functions. Run "Generate Webhooks". A webhook will be generated in your chat console
9\. In your ServiceNow instance, open "Business Rules" and click "New".
10\. Enter a Name for the new webhooks rule. Choose the table as "Incident" .Select" Advanced Checkbox". Select "after" from the "When" dropdown. Select "Insert". In Role conditions select web\_service\_admin.
11\. Go to the "Advanced" tab and paste this code:
```
(function executeRule(current, previous /*null when async*/) {
try {
var webhook_id="//Your Webhook ID"
var r = new sn_ws.RESTMessageV2();
r.setEndpoint("https://www.yellowant.com/market/applications/1930/webhooks/"+webhook_id);
body ='{' +
'"state"' + ':' + '"' + "created"+'"' + ',' +
'"sys_id"' + ':' + '"'+current.sys_id+'"' + ',' +
'"number"' + ':' + '"'+current.number+'"' + ',' +
'"assigned_to"' + ':' + '"'+current.assigned_to+'"' + ',' +
'"description"' + ':' + '"'+current.short_description+'"' + ',' +
'"assigned_to"' + ':' + '"'+current.assigned_to+'"'
+ '}';
r.setRequestBody(body);
r.setHttpMethod("POST");
var response = r.execute();
var responseBody = response.getBody();
var httpStatus = response.getStatusCode();
}
catch(ex) {
var message = ex.getMessage();
}
})(current, previous);
```
12\. Your ServiceNow integration is now complete.
# StackExchange
NOTE: StackExchange is integrated as a default application for all users. Only in the event that you have removed this or you need two separate instances of the application do you need to integrate using the below steps. StackExchange doesn't require your login details.
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "StackExchange" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. Since StackExchange doesn't take any user login, with that simple step, it is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Trello
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. n the search bar, look for "Trello" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Trello OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Trello is now integrated with YellowAnt.
6\. Trello is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Twitter
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Twitter" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Twitter OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and Twitter is now integrated with YellowAnt.
6\. Twitter is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# VictorOps
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "VictorOps" or simply click the icon.
3\. Once you find the application either in the dashboard or on the Marketplace click on Integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the VictorOps OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. For the next step, API access needs to be turned on in the VictorOps portal and an API key should be generated.
(i) To enable API access go to the API tab in the settings page of the VictorOps portal. Click on the "Activate API" button. On activating the API an API ID is generated.
(ii) Click on the "New Key" button to generate an API Key
6\. Enter the information in the integration window
7\. VictorOps is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
**COMING SOON: WEBHOOKS**
8\. VictorOps has webhooks for incident triggered,incident acknowledged and incident resolved. The webhooks need to be created manually.
Steps to create a webhook:
(i) Go to the settings page in the VictorOps portal. In settings select outgoing webhooks in the Alert Behavior dropdown. Click on the add webhook button.
(ii) Select the event type as "Any-Incident", method as POST, Content Type as application/json
(iii) The webhook URL needs to be given in the "To" box. The webhook url should be of the format `"https://example/webhook/webhook_id"` The webhook\_id is present in the database which should be provided to the user.
(iv) The payload should be the below content
`{"display_name":"${{ALERT.entity_display_name}}","message_type":"${{ALERT.message_type}}", "alert_count": "${{STATE.ALERT_COUNT}}","alert_phase": "${{STATE.CURRENT_ALERT_PHASE}}", "entity_id": "${{STATE.ENTITY_ID}}","incident_number": "${{STATE.INCIDENT_NAME}}", "message": "${{STATE.SERVICE}}"}`
(v) Add a description and click on save.
This will send a webhook to the specified url whenever a new incident is triggered, acknowledged or resolved.
9\. VictorOps is now integrated.
# Wikipedia
NOTE: Wikipedia is integrated as a default application for all users. Only in the event that you have removed this or you need two separate instances of the application do you need to integrate using the below steps. Wikipedia doesn't require your login details.
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "Wikipedia" under available applications. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. Since Wikipedia doesn't take any user login, with that simple step, it is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# YouTube
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2. In the search bar, look for "YouTube" or simply click the icon. If you have already integrated the application, you will be able to see it under "My Applications".
3\. Once you find the application either in the dashboard or on the Marketplace click on view. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the YouTube OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Allow the needed permissions and YouTube is now integrated with YellowAnt.
6\. YouTube is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Zendesk
1. Go to your YellowAnt Dashboard ([yoursubdomain.yellowant.com](https://github.com/yellowanthq/yellowant-help-center/tree/bdad19066023aa6a8b667a1d6f05b72945b49759/yoursubdomain.yellowant.com)) or head over to the [YellowAnt Marketplace](https://www.yellowant.com/marketplace).
2\. In the search bar, look for "Zendesk" or simply click the icon.
3\. Once you find the application either in the dashboard or on the Marketplace click on Integrate. You will be taken to a page where you'll find the integrate option/button. Click on the integrate button.
4\. You will be on the integration page which prompts you to add an account to the application. Click add account which takes you to the Zeendesk OAuth page.\
Note: Select a team before you click "+ ADD ACCOUNT".
5\. Enter your team's Zendesk name in the prompt and select notification settings. Then click on "Submit", then "Integrate". Allow permissions when prompted by Zendesk.
7\. Zendesk is now integrated and you get a message on your chat application for the same. You will be able to see it under your applications in the Dashboard too.
# Commanding Apps
YellowAnt offers you two different ways of controlling your applications. Apart from these, the notifications and automatic updates can be configured through the dashboard and can be changed through commands and dialog boxes as well.
**Using Dialog Boxes** \
YellowAnt offers you an unique way to manage your applications from chat apps like Slack or through the native console to command applications through dialog boxes. Basically, you type in the application name, which displays a bunch of commands for you to choose from. You choose to run that command, and a dialog box pops up to take any necessary inputs that are required for the particular action.
Let's take a look at this step by step.
Step 1. Depending on the chat platform you are using YellowAnt in, you can execute commands within DMs and channels by simply typing the "appname" example "gmail" in YellowAnt DM or "@yellowant appname" example "@yellowant gmail" in a channel.
Step 2. Choose the function you would like to execute and click on "Run this command" under the chosen function.
Step 3. Fill in the required fields and hit execute.
Step 4. Your function has been executed.
For example, if you want to send an email in Gmail all you have to do is click on "run this command" for the send option and then fill in the inputs, like the person's id you are sending the mail to, what the subject is and what the body is followed by which you just hit enter and the mail is sent right from within Slack/any chat app/native console. Let's see the process below.
Step 1. Type "gmail" in YellowAnt DM or "@yellowant gmail" in a channel.
Step 2. Choose the function you would like to execute (in this case "send" and click on "Run this command" under the chosen function.
Step 3. Fill in the required fields and hit execute.
Step 4. Your function has been executed.
**Using simple single-line commands**
The other way of controlling your applications is through simple commands of YellowAnt. It's basically like talking to the application in a chat window. Every command is easy and has a really short learning curve for memorizing them. Well, it's not really memorizing the command because they have a particular format and a very simple approach to using them. If you know what the application does, it's extremely easy to command the application.
For example, to send an email on Gmail this is the command:\
**gmail send subject "email subject" to "recipient email id" message "email body"** \
\
So, in the above scenario, the command would be as follows:\
**gmail send subject "YellowAnt is here!" to "" message "Hey, check out this cool way to send an email."**
After typing this, as soon as you hit enter the email gets sent.
**Workflows - Events and Commands**
YellowAnt being an ideal platform for automation, has incredibly powerful workflows. There are two types of workflows - command-triggered and event-triggered workflows.You can either choose existing workflows from the workflows marketplace or you can create your own workflows using the workflow builder. The comprehensive documentation for how to create workflows is listed under the main documentation of YellowAnt. In this documentation, let's explore all the possible triggers and actions for every integration. We will also look into some of the combination of applications that can help you create powerful workflows.
Workflows and their execution have been explained comprehensively in the "Workflows" section of the documentation.
# Notifications
YellowAnt also lets you receive notifications and updates on all your applications.When you sign up on YellowAnt and start integrating applications, we provide you with a default notification setting for every application, but through the console, you can configure your notifications and updates however you want them to be. This means you never have to leave a chat application like Slack to stay on top of things. In case you are not using any chat applications, you can use the YellowAnt native console to receive all your notifications in one place.
Using the YellowAnt dashboard you can simply navigate to the particular integration and change the settings for the notifications and updates. It's a very simple process and takes care of personal preferences. Here's how to do it:
1. Find the application in the Applications Panel of the Dashboard
2. Click on "Manage" on the application card
3. Scroll down to the notifications settings
4. Toggle on/off depending on what you require for each notification
*Flexibility to highly customize your applications' notifications.*
# Workflows
Since YellowAnt is connected to all your apps, you can create cross application workflows that can be triggered by a YellowAnt command or a background event from one of your apps. These powerful workflows ultimately let you automate a significant chunk of your tasks and take actions with incredible speed thereby reducing your response time to critical events.
Advantages of using YellowAnt Workflows
1. **Command-triggered** - Background running workflows are awesome, but a lot of times you would also want control over when you want to perform a bunch of tasks across applications by manually feeding data or intervening the process. These scenarios are great are perfect for using Command Workflows.
2. **Event-triggered** - Let your work be automated using event-workflows. In these cases, a particular trigger in a certain app initiates different actions across applications.
3. **Enriched with logic** - Add conditions in between steps, perform relational operations and even repeat actions over a certain data set using the various functions available under YellowAnt Workflows.
4. **Data formatting** - Format data based on your requirements in the beginning, in between or towards the end of workflows.
YellowAnt Workflows Marketplace makes numerous workflows available to you. You can publish your own workflows and let your team and other benefit from them.
# Command Workflows
YellowAnt is connected to all your apps so you can create cross application workflows that can be triggered by a YellowAnt command. This means with a simple command you can trigger a chain of events across different apps and even use the subsequent data in the process. You can trigger a chain of events by executing a simple command on Slack or Microsoft Teams.\
Let's take a took at an example,
A lot of people, first thing in the morning, check their emails, tasks for the day on Asana/Trello, look at their schedule and maybe perform a bunch of other tasks as well (like bugs due to be fixed or checking server statuses). With YellowAnt, you can have a simple command like "startmyday" which fetches all this information in a nice and sequential manner for you.
In this example, a simple command, "workflow startmyday" fetches mails from GMail and tasks due on Asana.
Take a look at another example.\
Let’s create one Slack command that gets a high-priority PagerDuty incident, creates a JIRA issue, sends an email to the Test team, and creates a calendar event for a war room meeting. Normally, this process would take atleast 5 minutes. With this command, it will take 5 seconds.
Similarly, users can create lot of different commands for different purposes using 35+ applications from the YellowAnt Marketplace.
# Building Command Workflows
In this section, we see step by step how to create a command workflow on YellowAnt. Following which, we will also cover a very common scenario as the example.
1. In your YellowAnt Dashboard, either from the Overview Panel or Command Workflows Panel, select "Add New" or "Create a Workflow" option respectively.
2\. This will take you to the "Workflow Builder" page. Select "Create Command Workflow" from the two choices.
3\. Choose a "Collection" in which you want to add the workflow to, Then, give a command name to the workflow. This will be useful in executing the command later from your chat window. Example, we are naming it "startmyday" and in order to execute it later, we would be using the command "workflow startmyday".
Note: A collection is a way of segregating workflows into sets in order to keep them more organized for every individual. This is totally up to the user and can be treated as having different set of workflows where each set forms a collection with some specific set of tasks. Watch out for custom collections for different domains which will soon launch on YellowAnt.
4\. Click on "Add Action in the left panel.
5\. Choose the application from which you want to use as your first "Action". Here, we select "GMail".
6\. Choose the action you want from to use from the application. Here, we select "fetch mails from a label".
7\. Fill in the required parameter field with the values you need. Here, we want mails fetched with the label "UNREAD".
8\. Click on "Add Action" in the left panel to add the second application.
9\. Choose the application from which you want to use as your second "Action". Here, we select "Asana".
10\. Choose the action you want from to use from the application. Here, we select "List user tasks".
11\. Fill in the required parameter field with the values you need. Here, we want tasks fetched from a workspace "yellowant.com".
12\. You can continue to create a chain of events across many apps. We will save it here. Click the button "Save" in the top panel.
13\. You will get a notification in your chat window about the creation of this new workflow. You can execute it right from there as well.
14\. To execute it at any point, just type "collectionname workflowname" and it executes. Example, "demo-collection startmyname".
## Another Example (more comprehensive):
Let’s create one Slack command that gets a high-priority PagerDuty incident, creates a JIRA issue, sends an email to the Test team, and creates a calendar event for a war room meeting. Normally, this process would take atleast 5 minutes. With this command, it will take 5 seconds.
1. In the YellowAnt console, click on “Create a Workflow”.
2\. Click on **Create New**
3\. Select **Command-based Workflow**
In the Trigger area, select your custom command name. In this case, we have given ***war-room.*** Our custom command will now start with **war-room**
In the **Input arguments** section, define the arguments(or variables) that this command will take.
4\. Click on **Add a new input argument.** In this case, the arguments will be **id**(Id of the PagerDuty incident).
It is now time to add some actions.
Our first action will be to search for the PagerDuty incident with Id **‘id**’. Our second action will be to create a JIRA ticket from the data that PagerDuty incident command returns.
5\. Click on **Add Action.**
6\. Select **PagerDuty**.
*Fetching incident details*
7\. In the actions, select **get\_incident**
*Fetching the incident details from PagerDuty*
The get\_incident command takes one argument, i.e the **incident\_number.** This corresponds to the **id** that we will pass in the argument.
8\. Click on the **incident\_number** textbox and type **@ .**This will bring a dropdown of all the available variable that we will pass in our command. Select **id**.
The next action is to create a JIRA ticket.
9\. Click on **Add Action** and select **JIRA.** In the actions dropdown, select **createissue.**
The PagerDuty **get\_incident** command gives us a bunch of data to use to create a new JIRA ticket. Use the **@** symbol to select the variable in the inputs. You can use multiple variables within one input box — YellowAnt automatically concatenates them into one string.
*Creating a JIRA ticket from Pagerduty data*
It’s time to send a mail to the testing team
10\. Click on **Add Action.** Select **GMail.** In the function list, select **send.**
*Creating an Email from Pagerduty data*
11\. Format your **subject** and **message** using the **@** symbol to get data from the PagerDuty command.
It’s now time to call a war room meeting using Google Calendar.
12\. Click on **Add Action.** Select **Google Calendar.** In the function list, select **create.**
Describe the event name — you can add some data from the previous steps using the **@** symbol. The **event** variable takes the event description in natural language. So you can say something like — **war room meeting for PD escalation @incident\_number in the next 5 minutes.**
*Creating a Google Calendar event*
13\. Click on **Save.**
# Trigger
A trigger for a command workflow is a command that triggers actions across various applications. The initiation point is when the user executes that command in the chat window or the YellowAnt native console. This means the workflow carries out the entire chain of events only if this command is executed and in no other circumstances. When you start building a workflow, you will be asked to create a command or it gets created with a default name.
Here we see, the default command name is: my-custom-workflow-name\
If you create another one with default name, it just gets appended by a number: my-custom-workflow-name-2
\
Here we see, the user command name is: startmyday You can also see the collection is: demo-collection
# Collection
A collection is a way of segregating workflows into sets in order to keep them more organized for every individual. This is totally up to the user and can be treated as having different set of workflows where each set forms a collection with some specific set of tasks. Watch out for custom collections for different domains which will soon launch on YellowAnt.
For command triggered workflows, collections also change the way the workflow is executed.
**If you create a new command triggered workflow and do not select/create a collection, by default it gets added to a collection called workflow.**
The way to execute such a command workflow would be to simply type: **workflow command-name** \
In case you select/add it to a workflow named myset, then the command changes to: **myset command-name**
Example 1:
In this case, the workflow command is "startmyday" and it belong to the collection "workflow" so the command to execute is "workflow startmyday".
Example 2:
In this case, the workflow command is "startmyday" and it belong to the collection "demo-collection" so the command to execute is "demo-collection startmyday".
We see that you can use the same command name, but place it uner different sets i.e. collections and use it in different contexts altogether without one interfering with the other.
This also makes it very easy for the user to view their workflows in the "My Workflows" panel by giving them an option to view them filtered by collections.
# Action
An Action is a task that is performed after the trigger command is executed. For any command workflow to work, there has to be at least one action to it. This is a very simple relationship - the trigger event acts as the stimulus for the next step i.e. the action.
Example: In this case, the trigger is the command and it results in two actions - fetch mails from a label and then also fetch Asana tasks.
Actions can occur based on conditions also, which we will cover in the next part of the documentation.
# Using Action Outputs
One important feature while creating workflows is to use action outputs. Action outputs are the outputs of a previously added action or coming right from the trigger event itself. You can access the action outputs by using "@" in any text field in the subsequent actions.
Example:
In the trigger "incident assignment in Pagerduty", a whole lot of data is sent along with the event for us to use in the subsequent actions.
In this step, we see action outputs from Pagerduty being used to create an email body for GMail. At the same time, we can a whole lot of action outputs coming from GMail's send function as well.
In this step, we have action outs of both GMail and Pagerduty available to us for use. Also, we can see "create a task" on Asana is generating more action outputs that you can use.
# Logical Functions
You can use **concat** and **if-else** formulas in a field.Formulas "concat" and "ifelse" can be applied to a field
**concat**: The ‘concat’ function allows you to join text/dynamic input in 1 string. Just select the concat function and add the text/dynamic input you want to concatenate.You can concatenate text, dynamic inputs or a combination of both
**ifelse**: The if-else function allows you to you check a dynamic input for a condition and perform actions based on whether or not they are true. Once you select the ifelse function, a variety of formulas will be available to apply on your dynamic inputs:ifelse contains a condition (with logical operators), true\_input and false\_input
* **contains** (checks for whether a string is in a parent string)
An example of "contains" operator
* **and** (combines 2 conditions such that the function is only true if both conditions are true)
* **or** (combines 2 conditions such that the function is true if either condition is true)
* **lt** (checks whether the variable on the left is less than the variable on the right)
* **gt** (checks whether the variable on the left is greater than the variable on the right)
* **lte** (checks whether the variable on the left is less or equal to than the variable on the right)
* **gte** (checks whether the variable on the left is greater than or equal to the variable on the right)
* **not equal** (compares 2 values and returns True if they are unequal)
* **equal** (compares 2 values and returns True if they are equal) expression
# Using Conditional Actions
You can also take actions based on conditions. The conditional functions available in YellowAnt are “for” and “ifelse”"for" and "ifelse" conditional actions are available in YellowAnt
## FOR function:
The “for” function allows you to take an action for every item in a list. To use the “for” function, select it as an action when you add an action.
**list\_inputs:** This is the list which will be looped and action will be taken on every item in the list. Pick from the dynamic content that becomes available when you click in the field
**action:** This is the action that will be repeated for each item in list\_inputs. You can add this action just like an “[Add Action](https://docs.yellowant.com/workflows/event-workflows/building-event-workflows/action)” stepAn example of using the "for" conditional action
## IFELSE function:
The if-else function allows you to you check a dynamic input for a condition and perform actions based on whether or not they are true.using "ifelse" conditional action
**condition:** Once you select the ifelse function, a variety of formulas will be available to apply on your dynamic inputs:
* **contains** (checks for whether a string is in a parent string)
* **and** (combines 2 conditions such that the function is only true if both conditions are true)
* **Or** (combines 2 conditions such that the function is true if either condition is true)
* **lt** (checks whether the variable on the left is less than the variable on the right)
* **gt** (checks whether the variable on the left is greater than the variable on the right)
* **lte** (checks whether the variable on the left is less or equal to than the variable on the right)
* **gte** (checks whether the variable on the left is greater than or equal to the variable on the right)
* **not equal** (compares 2 values and returns True if they are unequal)
* **equal** (compares 2 values and returns True if they are equal)
* **expression** (custom logic)
**true-action:** This action will be executed if the condition is TRUE. You can add this action just like an “[Add Action](https://docs.yellowant.com/workflows/event-workflows/building-event-workflows/action)” step
**false-action:** This action will be executed if the condition is FALSE. You can add this action just like an [“Add Action](https://docs.yellowant.com/workflows/event-workflows/building-event-workflows/action)” step
# Event Workflows
YellowAnt is connected to all your apps so you can create cross application workflows that can be triggered by an event of any application. This means a certain event of a certain application can trigger a chain of events across other apps and even use the subsequent data in the process.
In this example, a Pagerduty incident automatically creates a corresponding Jira issue.
# Building Event Workflows
In this section, we see step by step how to create an event workflow on YellowAnt. Following which, we will also cover a very common scenario as the example.
1. In your YellowAnt Dashboard, either from the Overview Panel or Event Workflows Panel, select "Add New" or "Create a Workflow" option respectively.\
2. This will take you to the "Workflow Builder" page. Select "Create Event Workflow" from the two choices.\
3. It automatically asks you for a "Trigger" application. The trigger application is the initiation application for the workflow. Here, we choose Pagerduty as the trigger application.\
4. Next step, asks you for a trigger event for the trigger application. That event is when the workflow starts. Here we choose an incident being assigned on Pagerduty as the trigger event.\
5. Choose a "Collection" in which you want to add the workflow to.
Note: A collection is a way of segregating workflows into sets in order to keep them more organized for every individual. This is totally up to the user and can be treated as having different set of workflows where each set forms a collection with some specific set of tasks. Watch out for custom collections for different domains which will soon launch on YellowAnt.\
6. Click on "Add Action in the left panel.
7. Choose the application from which you want to use your first "Action". Here, we select "GMail".\
8. Choose the action you want to use from the application. Here, we select "Send an email".\
9. Fill in the required parameter field with the values you need. Here, we want a mail sent to the manager whenever a new Pagerduty incident is assigned. We can use values from the first step i.e. the trigger by using "@" in any of the text fields as shown. We can use it to compose mails in GMail or task names in Asana or use this information fields in different ways. The possibilities are endless.\
10. Click on "Add Action" in the left panel to add the second application.
11. Choose the application from which you want to use as your second "Action". Here, we select "Asana".\
12. Choose the action you want to use from the application. Here, we select "Create a task".\
13. Fill in the required parameter fields to create a task. You can use Pagerduty data to fill in details of the task.\
14. You can continue to create a chain of events across many apps. We will save it here. Click the button "Save" in the top panel.\
15. You will get a notification in your chat window about the creation of this new workflow.\
16. It will execute every time the initial trigger event occurs.
# Trigger
A trigger for an event workflow is an event across some application that initiates the execution of the workflow. This means the workflow carries out the entire chain of events only if this event trigger is met. When you start building a workflow, you will be asked to choose the trigger event in a trigger application.
*Selecting an application in which the trigger event occurs.*\
*Selecting a specific event for the trigger application.*
## Some examples of triggers in applications:
*Trigger Events in Jira*
*Trigger Events in GitHub*
*Trigger Events in Jenkins*
# Collection
A collection is a way of segregating workflows into sets in order to keep them more organized for every individual. This is totally up to the user and can be treated as having different set of workflows where each set forms a collection with some specific set of tasks. Watch out for custom collections for different domains which will soon launch on YellowAnt.
**If you create a new event triggered workflow and do not select/create a collection, by default it gets added to a collection called workflow.**\
**If you add the workflow to a certain collection, it still makes no difference to the way it is executed (unlike command workflows). In event workflows, it is purely a better way to organize your workflows.**
Example 1:
In this case, the event workflow will add to the collection "workflow" since we did not select/create any collection.
Example 2:
In this case, the event workflow will add to the collection "demo-collection".
# Action
An Action is a task that is performed after the trigger event occurs. For any event workflow to work, there has to be at least one action too. This is a very simple relationship - the trigger event acts as the stimulus for the next step i.e. the action.
Example: In this case, the trigger is a Jenkins job notification and the action is sending an email in GMail.
Now actions can occur based on conditions also, which we will cover in the next part of the documentation.
# Using Action Outputs
## Using Action Outputs
One important feature while creating workflows is to use action outputs. Action outputs are the outputs of a previously added action or coming right from the trigger event itself. In case of command workflows, if no parameter is passed then the action outputs of the trigger remains empty. You can access the action outputs by using "@" in any text field in the subsequent actions.
Example 1:
### In the trigger command, since no parameters are being passed, we don't see any outputs available in the next step. And using "@" gives us no options.
### In this case, a parameter was passed in the trigger command, so we see "build" appearing as a data option.
# Logical Functions
You can use **concat** and **if-else** formulas in a field.
**concat**: The ‘concat’ function allows you to join text/dynamic input in 1 string. Just select the concat function and add the text/dynamic input you want to concatenate.
**ifelse**: The if-else function allows you to you check a dynamic input for a condition and perform actions based on whether or not they are true. Once you select the ifelse function, a variety of formulas will be available to apply on your dynamic inputs:
* **contains** (checks for whether a string is in a parent string)
* **and** (combines 2 conditions such that the function is only true if both conditions are true)
* **or** (combines 2 conditions such that the function is true if either condition is true)
* **lt** (checks whether the variable on the left is less than the variable on the right)
* **gt** (checks whether the variable on the left is greater than the variable on the right)
* **lte** (checks whether the variable on the left is less or equal to than the variable on the right)
* **gte** (checks whether the variable on the left is greater than or equal to the variable on the right)
* **not equal** (compares 2 values and returns True if they are unequal)
* **equal** (compares 2 values and returns True if they are equal) expression
# Using Conditonal Actions
You can also take actions based on conditions. The conditional functions available in YellowAnt are “for” and “ifelse”
#### **for function:**
The “for” function allows you to take an action for every item in a list. To use the “for” function, select it as an action when you add an action.
**list\_inputs:** This is the list which will be looped and action will be taken on every item in the list. Pick from the dynamic content that becomes available when you click in the field
**action:** This is the action that will be repeated for each item in list\_inputs. You can add this action just like an “[Add Action](https://docs.yellowant.com/workflows/event-workflows/building-event-workflows/action)” step
#### **ifelse function:**
The if-else function allows you to you check a dynamic input for a condition and perform actions based on whether or not they are true.
**condition:** Once you select the ifelse function, a variety of formulas will be available to apply on your dynamic inputs:
* **contains** (checks for whether a string is in a parent string)
* **and** (combines 2 conditions such that the function is only true if both conditions are true)
* **Or** (combines 2 conditions such that the function is true if either condition is true)
* **lt** (checks whether the variable on the left is less than the variable on the right)
* **gt** (checks whether the variable on the left is greater than the variable on the right)
* **lte** (checks whether the variable on the left is less or equal to than the variable on the right)
* **gte** (checks whether the variable on the left is greater than or equal to the variable on the right)
* **not equal** (compares 2 values and returns True if they are unequal)
* **equal** (compares 2 values and returns True if they are equal)
* **expression** (custom logic)
**true-action:** This action will be executed if the condition is TRUE. You can add this action just like an “[Add Action](https://docs.yellowant.com/workflows/event-workflows/building-event-workflows/action)” step
**false-action:** This action will be executed if the condition is FALSE. You can add this action just like an [“Add Action](https://docs.yellowant.com/workflows/event-workflows/building-event-workflows/action)” step
# Using Templates
## Workflow Templates
Workflow templates are pre-made workflows that you can find in the YellowAnt Workflows Marketplace. These workflows are built by:
* YellowAnt Team: Our team is constantly churning out new templates which we feel would be useful to our users. In the marketplace, you will also find collections which are sets of useful workflows bundled together.
* YellowAnt Users: Users of YellowAnt also build workflows and can publish it for others to use as well. When publishing the right to use them can be limited to either just their team or make it available to the entire community of YellowAnt users.
Steps to start using an existing template:
1. Go to the Workflow Marketplace. You can either go directly from the overview panels of the dashboard or either of the workflow panels in the dashboard.
2\. In the overview panel, under event or command workflows, click on "View All".
3\. In the Command Workflows panel, click on "Explore Marketplace"
4\. In the Event Workflows panel, click on "Explore Marketplace"
5\. You will be taken to the workflows page where you can select to either view your workflows or "Explore Marketplace".
6\. You can now view all the available templates. You can also apply application filters to find specific combinations of applications working together in applications.
7\. Click on "Use Template" for whichever workflow you want to start using. It gives you an overview of what the workflow does.
8\. Click on "Use Template" to view it in the builder. You can edit values as needed by you and hit "Save" and it will create a copy of the workflow for you with any updated details that you may have.
9\. After that, it's a regular workflow in your account and you can use it the way you like. It does not impact the template in any way.
## Publishing your Templates
Any YellowAnt can also publish their workflows for their team or anyone in the YellowAnt users community to use. Once you have created the workflow, all you have to do is hit "Publish" in the view and it gets published.
# System Commands
System Commands in YellowAnt let you administer and control your YellowAnt account. YellowAnt has three main system commands:
1. **yellowant**\
YellowAnt is the system administrator application. It is basically used to fetch and update your user information.\
You can perform the following actions using this:
a. Change application invoke name: Used to change the name of the application invoke name from "yellowant" to whatever the user wishes to call it.
b. Get User First Name: Fetches the first name of the registered user.
c. Get user time zone: Fetches the time zone of the user.
d. Set user First Name: Changes the first name of the user.
e. Set user time zone: Sets the time zone of the user.
2. **help**\
The help command in YellowAnt lets the user fetch important information about how to use a particular function or perform a certain action. The help command can be used in three ways:
a. As a means to get assistance with YellowAnt platform. Used as meta-function to get information about their general configuration with respect to YellowAnt.\
**Command: help** \
b. As a means to get assistance with a particular application. Using this lets you learn about the functions or actions available for an application/integration.\
**Command: help "appname"**\
**Example: help gmail**
c. As a means to get very specific information about how a particular function of an application works. You can see how to execute it and what parameters are required to execute it.\
**Command: help "appname" "functionname"**\
**Example: help gmail send**
3\. **cron** \
The "cron" system function is used to schedule an action/function execution at a specific time. It can be used to create a one-time executable or a recurring executable. You can schedule a function to be executed at a particular time of the day weekly, hourly or only once.
You start with the command "cron" which gives you three functions:\
a. **Delete a Cron job:** Used to delete already scheduled jobs. \
b. **List user Cron jobs:** Used to list scheduled jobs of the user. \
c. **Schedule a Cron Job:** There are multiple ways to schedule jobs on YellowAnt.
Example:\
To schedule a task to fetch your asana tasks everyday at 10:00 AM
To list the cron jobs you have:
To delete already scheduled tasks, you can list and hit the "delete" button or use the delete function to do the same:
# Plans and Pricing
YellowAnt has various different plans to cater to different businesses based on their needs. There are four different categories that we can classify them into:
1. Free
2. Basic
3. Premium
4. Enterprise
## Free Plan
### Who is this plan for?
The free plan is the most introductory plan of YellowAnt and is perfect for individuals trying out the platform and who want to use very basic integrations.
### What do you get in the free plan?
1. Maximum 5 non-premium applications
2. 1000 actions per month
3. Basic support with 48-72 hours turnaround
4. Build upto 5 applications
### What application can I use in the free plan?
Airbrake, Airtable, Asana, AWS, Cloudwatch, Bitbucket, Calendar (Google), Circle CI, Evernote, Freshdesk, Github, Gmail, Google Analytics, Google Contacts, Google Drive, Jenkins, RSS, Salesforce, Sentry, StackExchange, Trello, Twitter, Wikipedia, YouTube.\
Premium Applications (Unavailable in this plan): Jira, JiraO, Pagerduty, Pivotal Tracker, New Relic, Salesforce.
### How much do I pay for the free plan?
As the name says, you do not pay anything for the above mentioned features. However, in case you want assistance or sessions on building with YellowAnt, that might be charged based on requirements.
## Basic Plan
### Who is this plan for?
The basic plan is suitable for small businesses who are not using Premium applications yet. They can build unlimited applications (internal tools and microservices) to use with YellowAnt. The action limits are most suitable for small business teams.
### What do you get in the Basic plan?
1. Unlimited non-premium applications
2. 2500 actions per month
3. Basic support with 24-48 hours turnaround
4. Build unlimited applications
5. Basic developer support on how to build with YellowAnt
### What application can I use in the Basic plan?
Airbrake, Airtable, Asana, AWS, Cloudwatch, Bitbucket, Calendar (Google), Circle CI, Evernote, Freshdesk, Github, Gmail, Google Analytics, Google Contacts, Google Drive, Jenkins, RSS, Salesforce, Sentry, StackExchange, Trello, Twitter, Wikipedia, YouTube.\
Premium Applications (Unavailable in this plan): Jira, JiraO, Pagerduty, Pivotal Tracker, New Relic, Salesforce.
### How much do I pay for the Basic plan?
The basic plan has charges starting from just $3.5/user/month and going up to $5/user/month based on the period of subscription.
| Payment Period | Charges ($/user/month) |
| -------------- | ---------------------- |
| Yearly | $3.5 |
| Bi-Annually | $4.0 |
| Quarterly | $4.5 |
| Monthly | $5.0 |
## Premium Plan
### Who is this plan for?
The premium plan is suitable for medium to large businesses who are using Premium applications such as Salesforce, New Relic and more. Since, these businesses usually use a lot of internal services and apps, YellowAnt enables them to build unlimited applications (internal tools and microservices) to use on the automation platform. The action limits are most suitable for big business teams.
### What do you get in the Premium plan?
1. Unlimited applications
2. 5000 actions per month
3. Priority support with 12-24 hours turnaround
4. Build unlimited applications
5. Guided developer support on how to build with YellowAnt
### What application can I use in the Premium plan?
Airbrake, Airtable, Asana, AWS, Cloudwatch, Bitbucket, Calendar (Google), Circle CI, Evernote, Freshdesk, Github, Gmail, Google Analytics, Google Contacts, Google Drive, Jenkins, RSS, Salesforce, Sentry, StackExchange, Trello, Twitter, Wikipedia, YouTube.\
Premium Applications (Available in this plan): Jira, JiraO, Pagerduty, Pivotal Tracker, New Relic, Salesforce.
### How much do I pay for the Premium plan?
The premium plan has charges starting from just $7/user/month and going up to $10/user/month based on the period of subscription.
| Payment Period | Charges ($/user/month) |
| -------------- | ---------------------- |
| Yearly | $7.0 |
| Bi-Annually | $8.0 |
| Quarterly | $9.0 |
| Monthly | $10.0 |
## Enterprise Editions
### Who is this plan for?
The enterprise edition plan is suitable for medium to large businesses who use premium applications and require high levels of customization. They can be flexible in their requirements and usage.
### What do you get in the Enterprise edition plan?
1. Hosted, On-premise or Cloud
2. SAML
3. Unlimited applications
4. Unlimited actions per month
5. Priority support with 12 hours turnaround
6. Build unlimited applications
7. Guided developer support on how to build with YellowAnt
8. Security, compliance, billing, and platform integration management
### What application can I use in the Premium plan?
Airbrake, Airtable, Asana, AWS, Cloudwatch, Bitbucket, Calendar (Google), Circle CI, Evernote, Freshdesk, Github, Gmail, Google Analytics, Google Contacts, Google Drive, Jenkins, RSS, Salesforce, Sentry, StackExchange, Trello, Twitter, Wikipedia, YouTube.\
Premium Applications (Available in this plan): Jira, JiraO, Pagerduty, Pivotal Tracker, New Relic, Salesforce.
### How much do I pay for the Enterprise plan?
The expenses are based on the requirements and customization required by the users.
# Developer Community
Details coming soon. Please visit our [website ](https://www.yellowant.com/user/developers/)for more information.