HubSpot
HubSpot is a customer relationship management (CRM) platform that provides a suite of tools for marketing, sales, customer service, and content management.
HubSpot is a customer relationship management (CRM) platform that provides a suite of tools for marketing, sales, customer service, and content management.
Category: Customer Support. Adds 4 actions to a care flow.
What to configure
Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.
| Setting | Required | Notes |
|---|---|---|
| Access token | Yes | The access token will be used to authenticate requests to the HubSpot API Stored as a secret. |
| SMTP Password | No | Only required if you wish to send emails via the HubSpot SMTP API Stored as a secret. |
| SMTP Username | No | Only required if you wish to send emails via the HubSpot SMTP API |
Actions
HubSpot adds these 4 actions to a care flow. Add one to a step, then fill in its inputs.
Create or update contact
Create or update a contact in HubSpot
This action can be previewed in Studio before you publish, and retries automatically on a transient failure.
| Input | Type | Required | Description |
|---|---|---|---|
string | Yes | The email of the contact | |
| First name | string | No | The first name of the contact |
| Last name | string | No | The last name of the contact |
| Phone | string | No | The phone number of the contact |
| Custom properties | json | No | An object of key-values pairs of custom properties of the contact |
Returns:
| Data point | Type |
|---|---|
contactResource | json |
hubspotContactId | string |
Creates or updates a contact in HubSpot using the provided information. The patient is matched based on their email address—if a match is found, the existing contact is updated (PATCH); otherwise, a new contact is created.
Scope: crm.objects.contacts.write
Get contact
Retrieve the contact details from HubSpot
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Contact ID | string | Yes | — |
Returns:
| Data point | Type |
|---|---|
email | string |
firstName | string |
lastName | string |
Retrieve the details of a contact based on the provided contact ID.
Scope: crm.objects.contacts.read
Send email (Single Send API)
Send email with the Single Send API
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Email ID | string | Yes | The ID of the email (template) |
| From | string | Yes | — |
| To | string | Yes | — |
| Contact properties | json | No | A JSON map of contact property values. Each property will be set on the contact record. |
| Custom properties | json | No | A JSON map of key-value properties that will be rendered in the template. |
Returns:
| Data point | Type |
|---|---|
statusId | string |
The Single Send API is the recommended method for sending transactional emails with HubSpot. You can create email templates in your HubSpot account and use this action to send emails to recipients. This method allows you to take advantage of features like smart content and personalization.
Scope: transactional-email
Send email (SMTP)
Send email with SMTP
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| From | string | Yes | — |
| To | string | Yes | — |
| Subject | string | Yes | — |
| Message | html | Yes | — |
Send an email using HubSpot's SMTP server.
Sending emails via SMTP has some limitations. The most significant drawback is that you cannot use templates or apply styling when sending emails through SMTP. SMTP is generally more manual and less integrated with HubSpot's smart content and template features.
Scope: N/A
Setup and notes
Hubspot
HubSpot is a customer relationship management (CRM) platform that offers a comprehensive suite of tools for marketing, sales, customer service, and content management. It is widely recognized for its user-friendly interface and inbound marketing methodology, which focuses on attracting customers through valuable content and experiences instead of traditional advertising.
HubSpot provides features like email marketing, social media management, lead generation, analytics, and automation to help businesses attract, engage, and delight customers.
Settings and Setup
To use the HubSpot extension, you need an access token to authenticate with the HubSpot API. We recommend creating a private app in your HubSpot account for Awell and using the provided access token. You should only provide the minimum scopes necessary for the actions you intend to use. The required scopes for each action are listed in the documentation below.
SMTP Authentication
If you plan to use the "Send email with SMTP" action, you will need to provide your username and password to authenticate requests to HubSpot's SMTP server.
Add-ons
Sending transactional emails via HubSpot requires you to add the corresponding add-ons to your HubSpot account.
Changelog
Hubspot changelog
Where this page comes from
The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the
platform actually does rather than a description of it.
Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.