Skip to main content
GET
Get sync settings

Authorizations

Authorization
string
header
required

JWT authentication token

Response

Settings returned successfully

deal_name_template
string | null

Template for the deal name (supports variables {{var_contact_name}}, {{var_contact_email}}, etc.)

Example:

"Novo deal - {{var_contact_name}}"

lead_name_template
string | null

Template for the name of the automatically created lead (supports variables {{var_contact_name}}, etc.)

Example:

"Novo lead - {{var_contact_name}}"

auto_create_contact
boolean

Automatically create the contact in HubSpot when a conversation starts

Example:

false

owner_sync_source
enum<string>

Owner sync source (DISABLED, CONTACT_OWNER, DEAL_OWNER, LEAD_OWNER)

Available options:
DISABLED,
CONTACT_OWNER,
DEAL_OWNER,
LEAD_OWNER
Example:

"DISABLED"

sync_owner_on_webhook
boolean

Automatically sync the owner when a Contact/Deal/Lead is updated in HubSpot

Example:

false

realtime_property_lookup
boolean

Fetch the contact's properties from HubSpot in real time before building the Agent's prompt

Example:

false

send_transcript_on_resolve
boolean

Send the conversation transcript to the CONTACT in HubSpot (the mode comes from contact_transcript_mode; the name is historical)

Example:

false

contact_transcript_mode
enum<string>

When the transcript goes to the contact: ON_RESOLVE (when the conversation is closed) or AUTO (in segments, about 1h after the last message, at most 24h)

Available options:
ON_RESOLVE,
AUTO
Example:

"ON_RESOLVE"

send_transcript_to_deal
boolean

Also send the conversation transcript to the linked deal in HubSpot

Example:

false

deal_transcript_mode
enum<string>

When the transcript goes to the deal: ON_RESOLVE (when the conversation is closed) or AUTO (in segments, about 1h after the last message, at most 24h)

Available options:
ON_RESOLVE,
AUTO
Example:

"ON_RESOLVE"

search_contact_on_dispatch
boolean

Look up the contact in HubSpot by phone as soon as the campaign is dispatched. Default true; no control in the UI, it exists as an operational escape hatch

Example:

true

degraded_search_count_today
number

Lookups skipped today due to the volume cap (read-only, volatile indicator from Redis)

Example:

0

observed_webhook_sources
string[]

Webhook sources (changeSource) already observed on this portal (server-grown, read-only)

Example:
disabled_webhook_sources
string[]

Disabled webhook sources: events from these sources are dropped at ingestion (shedding)

Example: