Partilhar via

HubSpot Conversations V2 (Independent Publisher) (Preview)

  • Reference

The HubSpot conversations services enable you to manage and interact with the conversations inbox, channels, and messages.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://www.hubspot.com/products/crm/conversations
Privacy policy https://legal.hubspot.com/privacy-policy
Categories Marketing;Sales and CRM

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN') securestring The Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN') for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Archives a thread

Archives a single thread. The thread will be permanently deleted 30 days after placed in an archived state.
Generate a token

Generates a new visitor identification token. This token will be unique every time this endpoint is called, even if called with the same email address. This token is temporary and will expire after 12 hours.
Get a single actor

Retrieve a single actor.
Get a single channel

Retrieve a single channel.
Get a single channel account

Retrieve a single channel account.
Get a single conversations inbox

Retrieve a single conversations inbox.
Get a single message

Retrieve a single message.
Get a single thread

Retrieves a single thread.
Get actors

Resolve actors identifiers to the underlying actors and participants.
Get channel accounts

Retrieve a list of channel accounts.
Get channels

Retrieve a list of channels.
Get conversations inboxes

Retrieve a list of conversations inboxes.
Get message history for a thread

Retrieve a list of message history for a thread.
Get the original content of a single message

Returns the complete original text and rich text bodies of a message. This will be different from the text and rich text in the message itself if the message's truncationStatus is anything other than NOT_TRUNCATED.
Get threads

Retrieve a list of threads.
Send a message to a thread

Send a new message on a thread at the current timestamp.
Update a thread

Updates a single thread. Either a thread's status can be updated, or the thread can be restored.

Archives a thread

Operation ID:
ArchivesAThread

Archives a single thread. The thread will be permanently deleted 30 days after placed in an archived state.

Parameters

Name Key Required Type Description
Thread ID
 threadId True string

The thread identifier.

Returns

response
string

Generate a token

Operation ID:
GenerateAToken

Generates a new visitor identification token. This token will be unique every time this endpoint is called, even if called with the same email address. This token is temporary and will expire after 12 hours.

Parameters

Name Key Required Type Description
Email
 email string

The email address.
First Name
 firstName string

The first name.
Last Name
 lastName string

The last name.

Returns

Name Path Type Description
Token
 token string

The token.

Get a single actor

Operation ID:
GetASingleActor

Retrieve a single actor.

Parameters

Name Key Required Type Description
property
 property string

The property.
Actor ID
 actorId True string

The actor identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Type
 type string

The type.
Name
 name string

The name.
Email
 email string

The email address.
Avatar
 avatar string

The avatar.

Get a single channel

Operation ID:
GetASingleChannel

Retrieve a single channel.

Parameters

Name Key Required Type Description
Channel ID
 channelId True string

The channel identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.

Get a single channel account

Operation ID:
GetASingleChannelAccount

Retrieve a single channel account.

Parameters

Name Key Required Type Description
Channel Account ID
 channelAccountId True string

The channel account identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Channel ID
 channelId string

The channel identifier.
Name
 name string

The name.
Inbox ID
 inboxId string

The inbox identifier.
Active
 active boolean

Whether active.
Authorized
 authorized boolean

Whether authorized.
Created At
 createdAt string

When created at.
Type
 deliveryIdentifier.type string

The type.
Value
 deliveryIdentifier.value string

The value.

Get a single conversations inbox

Operation ID:
GetASingleConversationsInbox

Retrieve a single conversations inbox.

Parameters

Name Key Required Type Description
Inbox ID
 inboxId True string

The inbox identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Created At
 createdAt string

When created at.
Updated At
 updatedAt string

When updated at.

Get a single message

Operation ID:
GetASingleMessage

Retrieve a single message.

Parameters

Name Key Required Type Description
property
 property string

The property.
Thread ID
 threadId True string

The thread identifier.
Message ID
 messageId True string

The message identifier.

Returns

Name Path Type Description
Value
 value string

The value.

Get a single thread

Operation ID:
GetASingleThread

Retrieves a single thread.

Parameters

Name Key Required Type Description
Archived
 archived boolean

Whether archived.
property
 property string

The property.
Thread ID
 threadId True string

The thread identifier.

Returns

Name Path Type Description
Associated Contact ID
 associatedContactId string

The associated contact identifier.
Created At
 createdAt string

When created at.
ID
 id string

The identifier.
Inbox ID
 inboxId string

The inbox identifier.
Spam
 spam boolean

The spam.
Status
 status string

The status.
Closed At
 closedAt string

When closed at.
Latest Message Timestamp
 latestMessageTimestamp string

The latest message timestamp.
Latest Message Sent Timestamp
 latestMessageSentTimestamp string

The latest message sent timestamp.
Latest Message Received Timestamp
 latestMessageReceivedTimestamp string

The latest message received timestamp.
Assigned To
 assignedTo string

The assigned to.
Archived
 archived boolean

Whether archived.

Get actors

Operation ID:
GetActors

Resolve actors identifiers to the underlying actors and participants.

Parameters

Name Key Required Type Description
property
 property string

The property.
Inputs
 inputs array of string

The inputs.

Returns

Name Path Type Description
Completed At
 completedAt string

When completed at.
Results
 results array of object
ID
 results.id string

The identifier.
Type
 results.type string

The type.
Name
 results.name string

The name.
Email
 results.email string

The email address.
Avatar
 results.avatar string

The avatar.
Started At
 startedAt string

When started at.
Status
 status string

The status.
Requested At
 requestedAt string

When requested at.

Get channel accounts

Operation ID:
GetChannelAccounts

Retrieve a list of channel accounts.

Parameters

Name Key Required Type Description
Channel ID
 channelId string

The channel identifier.
Inbox ID
 inboxId string

The inbox identifier.
After
 after string

The After link.
Limit
 limit string

The response limit.
Sort
 sort string

The sort order.
Page Length
 defaultPageLength string

The default page length.

Returns

Name Path Type Description
Results
 results array of object
ID
 results.id string

The identifier.
Channel ID
 results.channelId string

The channel identifier.
Name
 results.name string

The name.
Inbox ID
 results.inboxId string

The inbox identifier.
Active
 results.active boolean

Whether active.
Authorized
 results.authorized boolean

Whether authorized.
Created At
 results.createdAt string

When created at.
Type
 results.deliveryIdentifier.type string

The type.
Value
 results.deliveryIdentifier.value string

The value.
Total
 total integer

The total.
After
 paging.next.after string

The After link.
Link
 paging.next.link string

The Link.

Get channels

Operation ID:
GetChannels

Retrieve a list of channels.

Parameters

Name Key Required Type Description
After
 after string

The After link.
Limit
 limit string

The response limit.
Sort
 sort string

The sort order.
Page Length
 defaultPageLength string

The default page length.

Returns

Name Path Type Description
Results
 results array of object
ID
 results.id string

The identifier.
Name
 results.name string

The name.
Total
 total integer

The total.
After
 paging.next.after string

The After link.
Link
 paging.next.link string

The Link.

Get conversations inboxes

Operation ID:
GetConversationsInboxes

Retrieve a list of conversations inboxes.

Parameters

Name Key Required Type Description
After
 after string

The After link.
Limit
 limit string

The response limit.
Sort
 sort string

The sort order.
Page Length
 defaultPageLength string

The default page length.

Returns

Name Path Type Description
Results
 results array of object
ID
 results.id string

The identifier.
Name
 results.name string

The name.
Created At
 results.createdAt string

When created at.
Updated At
 results.updatedAt string

When updated at.
Total
 total integer

The total.
After
 paging.next.after string

The After link.
Link
 paging.next.link string

The Link.

Get message history for a thread

Operation ID:
GetMessageHistoryForAThread

Retrieve a list of message history for a thread.

Parameters

Name Key Required Type Description
After
 after string

The After link.
Limit
 limit string

The response limit.
Sort
 sort string

The sort order.
Archived
 archived boolean

Whether archived.
property
 property string

The property.
Thread ID
 threadId True string

The thread identifier.

Returns

Name Path Type Description
Results
 results array of object
Archived
 results.archived boolean

Whether archived.
Client Type
 results.client.clientType string

The client type.
Integration App ID
 results.client.integrationAppId string

The integration app identifier.
Created At
 results.createdAt string

When created at.
Created By
 results.createdBy string

The created by.
Direction
 results.direction string

The direction.
ID
 results.id string

The identifier.
Recipients
 results.recipients array of object
Type
 results.recipients.deliveryIdentifier.type string

The type.
Value
 results.recipients.deliveryIdentifier.value string

The value.
Actor ID
 results.recipients.actorId string

The actor identifier.
Name
 results.recipients.name string

The name.
Recipient Field
 results.recipients.recipientField string

The recipient field.
Senders
 results.senders array of object
Actor ID
 results.senders.actorId string

The actor identifier.
Name
 results.senders.name string

The name.
Sender Field
 results.senders.senderField string

The sender field.
Type
 results.senders.deliveryIdentifier.type string

The type.
Value
 results.senders.deliveryIdentifier.value string

The value.
Text
 results.text string

The text.
Truncation Status
 results.truncationStatus string

The truncation status.
Type
 results.type string

The type.
Updated At
 results.updatedAt string

When updated at.
Rich Text
 results.richText string

The rich text.
Subject
 results.subject string

The subject.
In Reply To ID
 results.inReplyToId string

The in reply to identifier.
Status Type
 results.status.statusType string

The status type.
Error Message
 results.status.failureDetails.errorMessage string

The error message.
Channel ID
 results.channelId string

The channel identifier.
Channel Account ID
 results.channelAccountId string

The channel account identifier.
Conversations Thread ID
 results.conversationsThreadId string

The conversations thread identifier.
After
 paging.next.after string

The After link.
Link
 paging.next.link string

The Link.

Get the original content of a single message

Operation ID:
GetTheOriginalContentOfASingleMessage

Returns the complete original text and rich text bodies of a message. This will be different from the text and rich text in the message itself if the message's truncationStatus is anything other than NOT_TRUNCATED.

Parameters

Name Key Required Type Description
property
 property string

The property.
Thread ID
 threadId True string

The thread identifier.
Message ID
 messageId True string

The message identifier.

Returns

Name Path Type Description
Text
 text string

The text.
Rich Text
 richText string

The rick text.

Get threads

Operation ID:
GetThreads

Retrieve a list of threads.

Parameters

Name Key Required Type Description
After
 after string

The After link.
Limit
 limit string

The response limit.
Sort
 sort string

The sort order.
Inbox ID
 inboxId string

The inbox identifier.
Associated Contact ID
 associatedContactId string

The associated contact identifier.
Thread Status
 threadStatus string

The thread status.
Latest Timestamp
 latestMessageTimestampAfter string

The latest message timestamp after.
Archived
 archived boolean

Whether archived.
property
 property string

The property.

Returns

Name Path Type Description
Results
 results array of object
Associated Contact ID
 results.associatedContactId string

The associated contact identifier.
Created At
 results.createdAt string

When created at.
ID
 results.id string

The identifier.
Inbox ID
 results.inboxId string

The inbox identifier.
Spam
 results.spam boolean

Whether spam.
Status
 results.status string

The status.
Closed At
 results.closedAt string

When closed at.
Latest Message Timestamp
 results.latestMessageTimestamp string

The latest message timestamp.
Latest Message Sent Timestamp
 results.latestMessageSentTimestamp string

The latest message sent timestamp.
Latest Message Received Timestamp
 results.latestMessageReceivedTimestamp string

The latest message received timestamp.
Assigned To
 results.assignedTo string

The assigned to.
Archived
 results.archived boolean

Whether archived.
After
 paging.next.after string

The After link.
Link
 paging.next.link string

The Link.

Send a message to a thread

Operation ID:
SendAMessageToAThread

Send a new message on a thread at the current timestamp.

Parameters

Name Key Required Type Description
Thread ID
 threadId True string

The thread identifier.
Attachments
 attachments array of

The attachments object.
Channel Account ID
 channelAccountId string

The channel account identifier.
Channel ID
 channelId string

The channel identifier.
Type
 type string

The type.
Value
 value string

The value.
Actor ID
 actorId string

The actor identifier.
Name
 name string

The name.
Recipient Field
 recipientField string

The recipient field.
Type
 type string

The type.
Value
 value string

The value.
Sender Actor ID
 senderActorId string

The sender actor identifier.
Text
 text string

The text.
Type
 type string

The type.
Rich Text
 richText string

The rick text.
Subject
 subject string

The subject.

Returns

response
string

Update a thread

Operation ID:
UpdateAThread

Updates a single thread. Either a thread's status can be updated, or the thread can be restored.

Parameters

Name Key Required Type Description
Archived
 archived boolean

Whether archived.
Thread ID
 threadId True string

The thread identifier.
Status
 status string

The status.
Archived
 archived boolean

Whether archived.

Returns

Name Path Type Description
Associated Contact ID
 associatedContactId string

The associated contact identifier.
Created At
 createdAt string

When created at.
ID
 id string

The identifier.
Inbox ID
 inboxId string

The inbox identifier.
Spam
 spam boolean

The spam.
Status
 status string

The status.
Closed At
 closedAt string

When closed at.
Latest Message Timestamp
 latestMessageTimestamp string

The latest message timestamp.
Latest Message Sent Timestamp
 latestMessageSentTimestamp string

The latest message sent timestamp.
Latest Message Received Timestamp
 latestMessageReceivedTimestamp string

The latest message received timestamp.
Assigned To
 assignedTo string

The assigned to.
Archived
 archived boolean

Whether archived.

Definitions

string

This is the basic data type 'string'.