HubSpot Integration with Orkes Conductor
Available since
- v5.3.0 and later
Integrating HubSpot with Orkes Conductor lets you build workflows that interact with your HubSpot CRM using the following operations:
- Create Contact
- Get Contact
- List Contacts
- Search Contacts
- Search Contacts by Email
- Update Contact
- Delete Contact
- Create Company
- Get Company
- List Companies
- Search Companies
- Search Companies by Domain
- Update Company
- Delete Company
- Get Deal Pipelines
- Get Ticket Pipelines
- Create Deal
- Get Deal
- List Deals
- Search Deals
- Update Deal
- Delete Deal
- Create Ticket
- Get Ticket
- List Tickets
- Update Ticket
- Delete Ticket
- Create Note
- Get Note
- List Notes
- Delete Note
- Create Association
- Get Associations
- Get Owners
- Get Form Fields
- Submit Form
This guide explains how to set up and use the integration. Here’s an overview:
- Get the required credentials from HubSpot.
- Configure a new HubSpot integration in Orkes Conductor.
- Use HubSpot integration in workflows.
Step 1: Get the HubSpot credentials
To integrate HubSpot with Orkes Conductor, create a private (legacy) application in Hubspot and retrieve the access token.
To retrieve the access token:
- Log in to HubSpot.
- Select the settings icon (⚙) in the top navigation bar.
- Go to Integrations > Legacy Apps.
- Select Create legacy app.
- Enter a name and description for your app.
- Go to the Scopes tab and add the required scopes based on your use case.
| Scope | Operations |
|---|---|
| crm.objects.contacts.read | Get Contact, List Contacts, Search Contacts, Search Contacts by Email |
| crm.objects.contacts.write | Create Contact, Update Contact, Delete Contact |
| crm.objects.companies.read | Get Company, List Companies, Search Companies, Search Companies by Domain |
| crm.objects.companies.write | Create Company, Update Company, Delete Company |
| crm.objects.deals.read | Get Deal, List Deals, Search Deals, Get Deal Pipelines |
| crm.objects.deals.write | Create Deal, Update Deal, Delete Deal |
| crm.objects.owners.read | Get Owners |
| tickets | Create Ticket, Get Ticket, List Tickets, Update Ticket, Delete Ticket, Get Ticket Pipelines |
| forms | Get Form Fields, Submit Form |
- Select Create app.
- Go to the Auth tab and copy the Access Token.
Step 2: Add an integration for HubSpot
After obtaining the credentials, add a HubSpot integration to your Conductor cluster.
- Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
- Select + New integration.
- In the CRM section, choose HubSpot.
- Select + Add and enter the following parameters:
| Parameter | Description | Required/Optional |
|---|---|---|
| Integration name | A name for the integration. | Required. |
| API Key | The Access Token copied in Step 1. | Required. |
| Description | A description of the integration. | Required. |
- (Optional) Toggle the Active button off if you don’t want to activate the integration instantly.
- Select Save.
This creates the integration successfully.
Step 3: Use HubSpot integration in workflows
Once the integration is ready, this can be used directly within the workflows.
To use HubSpot integration in a workflow:
- Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
- Select + Define workflow.
- In your workflow, select the (+) icon and select Connected Apps.
- In Add Task panel on the right, search for HubSpot, and select the integration created in Step 2.
The following operations are available for use with this integration.
| Operation | Description |
|---|---|
| Create Contact | Creates a new contact in HubSpot. |
| Get Contact | Retrieves a contact by ID from HubSpot. |
| List Contacts | Lists contacts from HubSpot with optional pagination and sorting. |
| Search Contacts | Searches contacts in HubSpot using a query string. |
| Search Contacts by Email | Searches contacts in HubSpot by exact email address. |
| Update Contact | Updates an existing contact in HubSpot. |
| Delete Contact | Deletes a contact from HubSpot. |
| Create Company | Creates a new company in HubSpot. |
| Get Company | Retrieves a company by ID from HubSpot. |
| List Companies | Lists companies from HubSpot with optional pagination and sorting. |
| Search Companies | Searches companies in HubSpot by name. |
| Search Companies by Domain | Searches companies in HubSpot by domain name. |
| Update Company | Updates an existing company in HubSpot. |
| Delete Company | Deletes a company from HubSpot. |
| Get Deal Pipelines | Retrieves all deal pipelines and their stages from HubSpot. |
| Get Ticket Pipelines | Retrieves all ticket pipelines and their stages from HubSpot. |
| Create Deal | Creates a new deal in HubSpot. |
| Get Deal | Retrieves a deal by ID from HubSpot. |
| List Deals | Lists deals from HubSpot with optional pagination and sorting. |
| Search Deals | Searches deals in HubSpot by deal name. |
| Update Deal | Updates an existing deal in HubSpot. |
| Delete Deal | Deletes a deal from HubSpot. |
| Create Ticket | Creates a new ticket in HubSpot. |
| Get Ticket | Retrieves a ticket by ID from HubSpot. |
| List Tickets | Lists tickets from HubSpot with optional pagination and sorting. |
| Update Ticket | Updates an existing ticket in HubSpot. |
| Delete Ticket | Deletes a ticket from HubSpot. |
| Create Note | Creates a new note in HubSpot. |
| Get Note | Retrieves a note by ID from HubSpot. |
| List Notes | Lists notes from HubSpot with optional pagination and sorting. |
| Delete Note | Deletes a note from HubSpot. |
| Create Association | Associates two CRM objects in HubSpot. |
| Get Associations | Gets associations for a CRM object in HubSpot. |
| Get Owners | Lists all owners in HubSpot. |
| Get Form Fields | Gets all fields for a HubSpot form. |
| Submit Form | Submits data to a HubSpot form. |
- Select the required operation, configure the parameters, and select Save > Confirm.
- Select Execute to run the workflow.
For the complete operations parameters and output reference, see HubSpot Operation Reference.