EngageBay
The EngageBay modules allow you to watch, create, update, list, and delete companies, contacts, deals, tasks, and tracks in your EngageBay account.
Getting Started with EngageBay
Prerequisites
- An EngageBay account
In order to use EngageBay with Integromat, it is necessary to have an EngageBay account. If you do not have one, you can create an EngageBay account at engagebay.com/signup.
Connecting EngageBay to Integromat
To connect your EngageBay account to Integromat you need to obtain the API Key from your EngageBay account and insert it in the Create a connection dialog in the Integromat module.
1. Log in to your EngageBay account.
2. Click your Profile Icon > Account Settings > API & Tracking Code.
3. Copy the REST API Key to your clipboard.
4. Go to Integromat and open the EngageBay module's Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API Key copied in step 3 and click Continue.
The connection has been established.
Companies
Watch New Companies
Triggers when a new company is created.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of companies Integromat should return during one scenario execution cycle. |
Watch Companies Updates
Triggers when some company is updated.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of companies Integromat should return during one scenario execution cycle. |
Create a Company
Creates a company.
| Connection | Establish a connection to your EngageBay account. |
| Name | Enter the name of the company. |
| URL | Enter the company website's URL address. |
| Enter the contact email address of the company. |
Update a Company
Updates a company.
| Connection | Establish a connection to your EngageBay account. |
| ID | Select the Company ID whose details you want to update. |
| Name | Enter the name of the company. |
| URL | Enter the company website's URL address. |
| Enter the contact email address of the company. | |
| Phone | Enter the contact phone number of the company. |
| Address | Enter the company address. |
| Country | Enter the country name where the company is located. |
List Companies
Lists all companies.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of companies Integromat should return during one scenario execution cycle. |
Get a Company
Gets a company.
| Connection | Establish a connection to your EngageBay account. |
| Company ID | Select the Company ID whose details you want to retrieve. |
Delete a Company
Deletes a company.
| Connection | Establish a connection to your EngageBay account. |
| Company ID | Select the Company ID you want to delete. |
Deals
Watch New Deals
Triggers when a new deal is added.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of new deals Integromat should return during one scenario execution cycle. |
Watch Deals Updates
Trigger when some deal is updated.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of deals Integromat should return during one scenario execution cycle. |
List Deals
Lists deals by track or fro default track.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of deals Integromat should return during one scenario execution cycle. |
Get a Deal
Gets a single deal.
| Connection | Establish a connection to your EngageBay account. |
| Deal ID | Select the Deal ID whose details you want to retrieve. |
Create a Deal
Creates a deal.
| Connection | Establish a connection to your EngageBay account. |
| Name | Enter the name of the deal. |
| Amount | Enter the deal amount |
| Track Name | Select the status of the deal. For example, Won. |
| Milestone Label Name | Enter the milestone name of the deal. |
Delete a Deal
Deletes a deal.
| Connection | Establish a connection to your EngageBay account. |
| Deal ID | Select the Deal ID you want to delete. |
Contacts
Watch New Contacts
Triggers when a new contact is added.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of new contacts Integromat should return during one scenario execution cycle. |
Watch Contacts Updates
Triggers when some contact is updated.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of contacts Integromat should return during one scenario execution cycle. |
Create a Contact
Creates a contact.
| Connection | Establish a connection to your EngageBay account. |
| Score | Enter the maximum number of contacts Integromat should return during one scenario execution cycle. |
| Enter the email address of the contact. | |
| Phone | Enter the phone number of the contact. |
| Name | Enter the name of the contact. |
| Tags | Add the keywords to filter the contact when searching. |
Update a Contact
Updates contact info.
| Connection | Establish a connection to your EngageBay account. |
| Contact ID | Select the Contact ID whose details you want to update. |
| Enter the email address of the contact. | |
| Phone | Enter the phone number of the contact. |
| Name | Enter the name of the contact. |
| Last Name | Enter the last name of the contact. |
Delete Tags from a Contact
Removes one or more tags from contact.
| Connection | Establish a connection to your EngageBay account. |
| Contact Email | Enter the email address of the contact whose tags you want to delete. |
| Tags to be Deleted | Add the tags you want to delete. |
Add a Contact to a Sequence
Adds a contact to a sequence.
| Connection | Establish a connection to your EngageBay account. |
| Subscriber Email | Select the email address of the contact whom you want to add to a sequence. |
| Sequence ID | Add the tags you want to delete. |
Add Tags to Contact
Adds one or more tags to contact.
| Connection | Establish a connection to your EngageBay account. |
| Contact Email | Enter the email address of the contact to which you want to add the tags. |
| Tags to be Added | Add the tags for the contact. |
Add a Contact to a Form
Adds a contact to a form.
| Connection | Establish a connection to your EngageBay account. |
| Subscriber Email | Enter the email address of the contact whom you want to add to the form. |
| Form ID | Enter the Form ID to which you want to add the contact. |
List Contacts
Gets a list of all contacts.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of contacts Integromat should return during one scenario execution cycle. |
Get a Contact
Gets contact by ID.
| Connection | Establish a connection to your EngageBay account. |
| Contact ID | Select the Contact ID whose details you want to retrieve. |
Delete a Contact
Deletes single contact from the account.
| Connection | Establish a connection to your EngageBay account. |
| Contact ID | Select the Contact ID you want to delete. |
Tasks
Watch New Tasks
Triggers when a new task is added.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of tasks Integromat should return during one scenario execution cycle. |
| Task Status | Select the status of the task:
|
| Task Type | Select the task type:
|
Watch Tasks Updates
Triggers when some task is updated.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of tasks Integromat should return during one scenario execution cycle. |
| Task Status | Select the status of the task:
|
| Task Type | Select the task type of the task:
|
List Tasks
Lists all tasks.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number of tasks Integromat should return during one scenario execution cycle. |
| Task Status | Select the status of the task:
|
| Task Type | Select the task type:
|
Get a Task
Gets a task.
| Connection | Establish a connection to your EngageBay account. |
| Task ID | Select the Task ID whose details you want to retrieve. |
Create a Task
Creates a task.
| Connection | Establish a connection to your EngageBay account. |
| Name | Enter the name of the task. |
| Description | Enter the details of the task. |
| Entity Group Name | Enter the group name to which this task belongs to. |
| Is Due | Select whether the task is due:
|
| Name Sort | Enter the name to sort the tasks |
| Type | Select the task status:
|
| Updated Time | Enter the time when the task was last updated. |
| Closed Date | Enter the task when the task is closed. |
| Task Milestone | Enter the details of the task milestones. |
| Queue ID | Enter the Queue ID of the task in the list of the tasks. |
| Contact IDs | Add the Contact IDs to whom the task is assigned. |
| Company IDs | Add the Company IDs associated with the task. |
| Deal IDs | Add the Deal IDs associated with the task. |
| Subscribers | Add the subscribers associated with the task. |
| Companies | Add the companies associated with the task. |
| Deals | Add the deals associated with the task. |
Update a Task
Updates a task.
| Connection | Establish a connection to your EngageBay account. |
| Task ID | Select the Task ID you want to update. |
| Name | Enter the name of the task. |
| Description | Enter the details of the task. |
| Entity Group Name | Enter the group name to which this task belongs to. |
| Is Due | Select whether the task is due:
|
| Name Sort | Enter the name to sort the tasks |
| Type | Select the task status:
|
| Updated Time | Enter the time when the task was last updated. |
| Closed Date | Enter the task when the task is closed. |
| Task Milestone | Enter the details of the task milestones. |
| Queue ID | Enter the Queue ID of the task in the list of the tasks. |
| Contact IDs | Add the Contact IDs to whom the task is assigned. |
| Company IDs | Add the Company IDs associated with the task. |
| Deal IDs | Add the Deal IDs associated with the task. |
| Subscribers | Add the subscribers associated with the task. |
| Companies | Add the companies associated with the task. |
| Deals | Add the deals associated with the task. |
Delete a Task
Deletes a task.
| Connection | Establish a connection to your EngageBay account. |
| Task ID | Select the Task ID you want to delete. |
Owners
List Owners
Gets a list of all the owners.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number owners Integromat should return during one scenario execution cycle. |
Tracks
List Tracks
Gets a list of all tracks.
| Connection | Establish a connection to your EngageBay account. |
| Limit | Enter the maximum number tracks Integromat should return during one scenario execution cycle. |
Create a Track
Creates a new track.
| Connection | Establish a connection to your EngageBay account. | ||||||||||||
| Name | Enter the name of the track. | ||||||||||||
| Milestones | Add the milestones:
|
Get a Track
Gets a track by ID.
| Connection | Establish a connection to your EngageBay account. |
| Track ID | Select the Track ID whose details you want to retrieve. |
Delete a Track
Deletes a track.
| Connection | Establish a connection to your EngageBay account. |
| Track ID | Select the Track ID you want to delete. |
Update a Track
Updates a track.
| Connection | Establish a connection to your EngageBay account. | ||||||||||||
| Track ID | Select the Track ID you want to update. | ||||||||||||
| Created Time | Enter the time when the track is created. | ||||||||||||
| Milestones | Add the milestones:
| ||||||||||||
| Name | Enter a name for the track. |
Other
Make an API Call
Performs an arbitrary authorized API call.
| Connection | Establish a connection to your EngageBay account. |
| URL | Enter a path relative to For the list of available endpoints, refer to the EngageBay API Documentation. |
| Method | Select the HTTP method you want to use: GET POST PUT PATCH DELETE |
| Headers | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
| Query String | Enter the request query string. |
| Body | Enter the body content for your API call. |
Example of Use - List Deals
The following API call returns all the deals from your EngageBay account:
URL:/panel/deals
Method:GET
Matches of the search can be found in the module's Output under Bundle > Body.
In our example, 2 deals were returned:
