Connect AI agents to Front

Scalekit connector

The Front connector lets your AI agent act in each user's Front account. Each user signs in to Front once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 55 tools.

Tools: 55
What they doRead · write · destructive: 31 · 20 · 431 read20 write4 destructive
Users sign in with: OAuth
OAuth app: Scalekit's or your own

Setup

Install the SDK
- Node.js
- Python
Terminal window
npm install @scalekit-sdk/node dotenv
Terminal window
pip install scalekit-sdk-python python-dotenv
Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Front connection
In AgentKit > Connections, create a Front connection. The name you give it is the connection_name your code passes. See Configure connections.
Scalekit credentials are available for Front, so you don't need to register an OAuth app.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'front'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize Front:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'front_list_accounts',
27
  toolInput: {},
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "front"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize Front:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={},
27
    tool_name="front_list_accounts",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

front_get_accountFetch a single account from Front by ID, domain, or external ID resource alias.Read-only
Get Account
Fetch a single account from Front by ID, domain, or external ID resource alias.
Inputs
account_idstringrequired
The Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_get_channelFetch a single channel from Front by ID or address resource alias.Read-only
Get Channel
Fetch a single channel from Front by ID or address resource alias.
Inputs
channel_idstringrequired
The Channel ID. Alternatively, you can supply the channel address as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_get_commentFetch a single Front comment by its ID.Read-only
Get Comment
Fetch a single Front comment by its ID. Requires scope comments:read.
Inputs
comment_idstringrequired
The unique Front identifier for the comment to fetch, e.g. com_123.
Also accepts schema_version and tool_version to pin a version.
front_get_contactFetch a single contact by its Front contact ID.Read-only
Get Contact
Fetch a single contact by its Front contact ID.
Inputs
contact_idstringrequired
The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_get_conversationFetch a single conversation by its ID.Read-only
Get Conversation
Fetch a single conversation by its ID. Required scope: conversations:read.
Inputs
conversation_idstringrequired
The conversation ID.
Also accepts schema_version and tool_version to pin a version.
front_get_inboxFetch a single Front inbox by its ID, returning its name, type, and related resource links.Read-only
Get Inbox
Fetch a single Front inbox by its ID, returning its name, type, and related resource links. Requires the inboxes:read scope.
Inputs
inbox_idstringrequired
The unique Front identifier of the inbox to fetch, e.g. 'inb_123'.
Also accepts schema_version and tool_version to pin a version.
front_get_messageFetch a single Front message by its ID, including its body, recipients, and attachment metadata.Read-only
Get Message
Fetch a single Front message by its ID, including its body, recipients, and attachment metadata. Requires scope messages:read.
Inputs
message_idstringrequired
The unique Front identifier for the message to fetch, e.g. msg_123.
Also accepts schema_version and tool_version to pin a version.
front_get_message_templateFetch a single message template (canned answer) by its ID from Front.Read-only
Get Message Template
Fetch a single message template (canned answer) by its ID from Front.
Inputs
message_template_idstringrequired
The message template ID.
Also accepts schema_version and tool_version to pin a version.
front_get_tagFetch a single Front tag by its ID, returning its name, highlight color, visibility settings, and related resource links.Read-only
Get Tag
Fetch a single Front tag by its ID, returning its name, highlight color, visibility settings, and related resource links. Requires the tags:read scope.
Inputs
tag_idstringrequired
The unique Front identifier of the tag to fetch, e.g. 'tag_123'.
Also accepts schema_version and tool_version to pin a version.
front_get_teammateFetch a single teammate from Front by ID or email resource alias.Read-only
Get Teammate
Fetch a single teammate from Front by ID or email resource alias.
Inputs
teammate_idstringrequired
The teammate ID. Alternatively, you can supply an email as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_list_accountsList the accounts of the Front company, with optional pagination.Read-only
List Accounts
List the accounts of the Front company, with optional pagination.
Inputs
limitinteger
Max number of results per page.
page_tokenstring
Token to use to request the next page.
Also accepts schema_version and tool_version to pin a version.
front_list_channelsList the channels of the Front company.Read-only
List Channels
List the channels of the Front company.
Inputs
This tool takes no inputs.
Also accepts schema_version and tool_version to pin a version.
front_list_contact_groupsList the contact groups in Front.Read-only
List Contact Groups
List the contact groups in Front. This is a deprecated Front endpoint; Front recommends using the contact lists endpoints instead, but this remains supported for existing integrations.
Inputs
This tool takes no inputs.
Also accepts schema_version and tool_version to pin a version.
front_list_contact_notesList the notes added to a contact.Read-only
List Contact Notes
List the notes added to a contact.
Inputs
contact_idstringrequired
The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_list_contactsList the contacts of the company, with optional search query, sorting, and pagination.Read-only
List Contacts
List the contacts of the company, with optional search query, sorting, and pagination.
Inputs
limitinteger
Max number of results per page.
page_tokenstring
Token to use to request the next page of results.
qstring
Search query object with optional properties updated_after and updated_before, as a JSON string.
sort_bystring
Field used to sort the contacts. Either created_at or updated_at.one of created_atupdated_at
sort_orderstring
Order by which results should be sorted.one of ascdesc
Also accepts schema_version and tool_version to pin a version.
front_list_conversation_commentsList the comments in a Front conversation in reverse chronological order (newest first).Read-only
List Conversation Comments
List the comments in a Front conversation in reverse chronological order (newest first). Requires scope comments:read.
Inputs
conversation_idstringrequired
The unique Front identifier for the conversation whose comments should be listed, e.g. cnv_123.
Also accepts schema_version and tool_version to pin a version.
front_list_conversation_messagesList the messages in a conversation in reverse chronological order (newest first).Read-only
List Conversation Messages
List the messages in a conversation in reverse chronological order (newest first). Required scope: messages:read.
Inputs
conversation_idstringrequired
The conversation ID.
limitinteger
Max number of results per page (maximum 100).
page_tokenstring
Token to use to request the next page.
sort_bystring
Field used to sort the messages. Only supports 'created_at'.
sort_orderstring
Order by which results should be sorted.one of ascdesc
Also accepts schema_version and tool_version to pin a version.
front_list_conversationsList the conversations in the company in reverse chronological order (most recently updated first).Read-only
List Conversations
List the conversations in the company in reverse chronological order (most recently updated first). For more advanced filtering, use the search endpoint. Required scope: conversations:read.
Inputs
limitinteger
Max number of results per page (maximum 100).
page_tokenstring
Token to use to request the next page.
qstring
Search query object with a property `statuses`, whose value should be a list of conversation statuses (assigned, unassigned, archived, or trashed). If ticketing is enabled, this endpoint accepts either status_categories (open, waiting, resolved) or status_ids as an alternative.
sort_bystring
Field used to sort the conversations. Only supports 'date'.
sort_orderstring
Order by which results should be sorted.one of ascdesc
Also accepts schema_version and tool_version to pin a version.
front_list_custom_fieldsList the custom fields that can be attached to a contact in Front.Read-only
List Custom Fields
List the custom fields that can be attached to a contact in Front. Note: this endpoint is deprecated by Front in favor of GET /contacts/custom_fields, but remains functional.
Inputs
This tool takes no inputs.
Also accepts schema_version and tool_version to pin a version.
front_list_inbox_channelsList all channels (e.g.Read-only
List Inbox Channels
List all channels (e.g. email addresses, SMS numbers) attached to a specific Front inbox. Requires the channels:read scope.
Inputs
inbox_idstringrequired
The unique Front identifier of the inbox whose channels should be listed, e.g. 'inb_123'.
Also accepts schema_version and tool_version to pin a version.
front_list_inbox_conversationsList the conversations in a specific Front inbox, with optional status filtering and pagination.Read-only
List Inbox Conversations
List the conversations in a specific Front inbox, with optional status filtering and pagination. For more advanced filtering use the conversation search endpoint instead. Requires the conversations:read scope.
Inputs
inbox_idstringrequired
The unique Front identifier of the inbox whose conversations should be listed, e.g. 'inb_123'.
limitinteger
Maximum number of results to return per page. Maximum allowed value is 100.
page_tokenstring
Pagination token used to request the next page of results. Use the token returned in the previous response's pagination links.
qstring
Search query object (as a JSON string) with a 'statuses' property whose value is a list of conversation statuses (assigned, unassigned, archived, or trashed). If ticketing is enabled, this can instead be 'status_categories' (open, waiting, resolved) or 'status_ids'.
Also accepts schema_version and tool_version to pin a version.
front_list_inboxesList all inboxes in the Front company (workspace) that the API token has access to.Read-only
List Inboxes
List all inboxes in the Front company (workspace) that the API token has access to. Returns inbox IDs, names, and related resource links. Requires the inboxes:read scope.
Inputs
This tool takes no inputs.
Also accepts schema_version and tool_version to pin a version.
front_list_kb_articlesList the articles in a given knowledge base in Front, with pagination support.Read-only
List Knowledge Base Articles
List the articles in a given knowledge base in Front, with pagination support.
Inputs
knowledge_base_idstringrequired
The ID of the knowledge base.
limitinteger
Max number of results per page.
page_tokenstring
Token to use to request the next page.
Also accepts schema_version and tool_version to pin a version.
front_list_knowledge_basesList the knowledge bases of the company in Front.Read-only
List Knowledge Bases
List the knowledge bases of the company in Front.
Inputs
This tool takes no inputs.
Also accepts schema_version and tool_version to pin a version.
front_list_linksList the links of the Front company, paginated by ID.Read-only
List Links
List the links of the Front company, paginated by ID.
Inputs
limitinteger
Max number of results per page.
page_tokenstring
Token to use to request the next page.
Also accepts schema_version and tool_version to pin a version.
front_list_message_templatesList the message templates (canned answers) available in the Front workspace, with optional sorting.Read-only
List Message Templates
List the message templates (canned answers) available in the Front workspace, with optional sorting.
Inputs
sort_bystring
Field used to sort the message templates.one of created_atupdated_atsort_order
sort_orderstring
Order by which results should be sorted.one of ascdesc
Also accepts schema_version and tool_version to pin a version.
front_list_tagsList all tags that the API token has access to, whether they are company tags, team tags, or teammate tags, with optional sorting and pagination.Read-only
List Tags
List all tags that the API token has access to, whether they are company tags, team tags, or teammate tags, with optional sorting and pagination. Requires the tags:read scope.
Inputs
limitinteger
Maximum number of results to return per page. Maximum allowed value is 100.
page_tokenstring
Pagination token used to request the next page of results. Use the token returned in the previous response's pagination links.
sort_bystring
Field used to sort the tags. Only 'id' is supported.
sort_orderstring
Order by which results should be sorted. One of 'asc' or 'desc'.one of ascdesc
Also accepts schema_version and tool_version to pin a version.
front_list_teammate_signaturesList the signatures belonging to a given teammate in Front.Read-only
List Teammate Signatures
List the signatures belonging to a given teammate in Front.
Inputs
teammate_idstringrequired
The teammate ID. Alternatively, you can supply an email as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_list_teammatesList the teammates in the Front company.Read-only
List Teammates
List the teammates in the Front company.
Inputs
This tool takes no inputs.
Also accepts schema_version and tool_version to pin a version.
front_list_teamsList the teams (workspaces) in the Front company.Read-only
List Teams
List the teams (workspaces) in the Front company.
Inputs
This tool takes no inputs.
Also accepts schema_version and tool_version to pin a version.
front_search_conversationsSearch for conversations.Read-only
Search Conversations
Search for conversations. Response includes a count of total matches and an array of conversations in descending order by last activity. This endpoint is subject to proportional rate limiting at 40% of the company's rate limit. Required scope: conversations:read.
Inputs
querystringrequired
Search query string. See Front's search syntax documentation for usage details.
limitinteger
Max number of results per page (maximum 100).
page_tokenstring
Token to use to request the next page.
Also accepts schema_version and tool_version to pin a version.
front_add_contact_handleAdd a new handle (e.g.Write
Add Contact Handle
Add a new handle (e.g. email, phone, Twitter) to an existing contact.
Inputs
contact_idstringrequired
The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
handlestringrequired
Handle used to reach the contact.
sourcestringrequired
Source of the handle.one of twitteremailphonefacebookintercomfront_chatcustom
Also accepts schema_version and tool_version to pin a version.
front_add_contact_noteCreate a new note on a contact, authored by a specific teammate.Write
Add Contact Note
Create a new note on a contact, authored by a specific teammate.
Inputs
author_idstringrequired
ID of the teammate creating the note.
bodystringrequired
Content of the note.
contact_idstringrequired
The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_add_conversation_commentAdd an internal comment to a Front conversation.Write
Add Conversation Comment
Add an internal comment to a Front conversation. Comments are only visible to teammates, not to external recipients. Requires scope comments:write. To start a brand-new comment-only conversation, use the Create Discussion Conversation endpoint instead.
Inputs
bodystringrequired
Content of the comment. Can include markdown formatting.
conversation_idstringrequired
The unique Front identifier for the conversation to comment on, e.g. cnv_123.
author_idstring
ID of the teammate creating the comment, e.g. tea_123. If omitted, the comment posts as the API token or OAuth client of the requester.
is_pinnedboolean
Whether or not the comment is pinned in its conversation.
Also accepts schema_version and tool_version to pin a version.
front_add_conversation_tagAdd one or more tags to a conversation.Write
Add Conversation Tag
Add one or more tags to a conversation. Required scope: conversations:write.
Inputs
conversation_idstringrequired
The conversation ID.
tag_idsarrayrequired
Tag IDs to add to the conversation.
Also accepts schema_version and tool_version to pin a version.
front_create_contactCreate a new contact at the company level, with one or more handles (e.g.Write
Create Contact
Create a new contact at the company level, with one or more handles (e.g. email, phone, Twitter).
Inputs
handlesarrayrequired
List of handles for this contact. Each item is an object with 'handle' and 'source' fields, e.g. [{"handle": "dwight@limitlesspaper.com", "source": "email"}].
custom_fieldsobject
Custom fields for this contact, keyed by the custom field name defined in the Front UI.
descriptionstring
Contact description.
linksarray
List of links associated with the contact.
list_namesarray
List of contact list names the contact belongs to. Missing lists will be created automatically.
namestring
Contact name.
Also accepts schema_version and tool_version to pin a version.
front_create_conversationCreate a new conversation of type discussion or task.Write
Create Conversation
Create a new conversation of type discussion or task. Both types only support comments. To create a conversation that supports messages, use the Reply To Conversation / channel message endpoints instead. Required scope: conversations:write.
Inputs
subjectstringrequired
Subject of the conversation. Used as the title for tasks.
typestringrequired
Conversation type.one of discussiontask
comment_author_idstring
ID of the teammate creating the comment. If omitted, will post as the API token or OAuth client of the requester.
comment_bodystring
Content of the starter comment. Required for discussions, optional for tasks.
custom_fieldsobject
Custom fields for this conversation, sent as an object of key:value pairs.
descriptionstring
Description of the task. Only allowed when type is task.
due_atnumber
Unix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed when type is task.
inbox_idstring
Inbox ID for the conversation. Either inbox_id OR teammate_ids must be provided (not both).
teammate_idsarray
Teammates to add to the conversation. Either inbox_id OR teammate_ids must be provided (not both).
Also accepts schema_version and tool_version to pin a version.
front_create_draftCreate a draft message that becomes the first message of a new Front conversation.Write
Create Draft
Create a draft message that becomes the first message of a new Front conversation. Requires scope drafts:write.
Inputs
bodystringrequired
Body of the draft.
channel_idstringrequired
The channel ID to create the draft from, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
author_idstring
ID of the teammate on behalf of whom the draft is created, e.g. tea_123. If omitted, the draft is created as the API token or application making the request.
bccarray
List of recipient handles who will receive a blind copy of the message once the draft is sent.
ccarray
List of recipient handles who will receive a copy of the message once the draft is sent.
modestring
Mode of the draft to create. Can be 'private' (visible to the author only) or 'shared' (visible to all teammates with access to the conversation). Defaults to private.one of privateshareddefault private
quote_bodystring
Body for the quote that the message is referencing. Only available on email channels.
should_add_default_signatureboolean
Whether Front should try to resolve a signature for the message. Ignored if signature_id is set. Defaults to false.
signature_idstring
ID of the signature to attach to this draft. If null, no signature is attached.
subjectstring
Subject of the draft.
toarray
List of recipient handles who will receive the message once the draft is sent.
Also accepts schema_version and tool_version to pin a version.
front_create_draft_replyCreate a new draft as a reply to the last message in a Front conversation.Write
Create Draft Reply
Create a new draft as a reply to the last message in a Front conversation. Requires scope drafts:write.
Inputs
bodystringrequired
Body of the draft.
channel_idstringrequired
ID of the channel from which the draft will be sent, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
conversation_idstringrequired
The unique Front identifier for the conversation to reply to, e.g. cnv_123.
author_idstring
ID of the teammate on behalf of whom the draft is created, e.g. tea_123. If omitted, the draft is created as the API token or application making the request.
bccarray
List of the recipient handles who will receive a blind copy of the message once the draft is sent.
ccarray
List of recipient handles who will receive a copy of the message once the draft is sent.
modestring
Mode of the draft to create. Can be 'private' (visible to the author only) or 'shared' (visible to all teammates with access to the conversation). Defaults to private.one of privateshareddefault private
quote_bodystring
Body for the quote that the message is referencing. Only available on email channels.
should_add_default_signatureboolean
Whether Front should try to resolve a signature for the message. Ignored if signature_id is set. Defaults to false.
signature_idstring
ID of the signature to attach to this draft. If null, no signature is attached.
subjectstring
Subject of the draft.
toarray
List of recipient handles who will receive the message once the draft is sent.
Also accepts schema_version and tool_version to pin a version.
front_create_linkCreate a link connecting a Front conversation to an external resource or application object.Write
Create Link
Create a link connecting a Front conversation to an external resource or application object.
Inputs
external_urlstring
Underlying identifying URL of the link. Required if 'pattern' is not supplied; supply either 'external_url' or 'pattern', but not both.
namestring
Name of the link. If none is specified, the external_url is used as a default.
patternstring
The string that application object configurations will match on to update a specific application object. Required if 'external_url' is not supplied; supply either 'pattern' or 'external_url', but not both.
Also accepts schema_version and tool_version to pin a version.
front_create_tagCreate a tag in the oldest team (workspace) accessible to the API token.Write
Create Tag
Create a tag in the oldest team (workspace) accessible to the API token. This is a legacy endpoint; prefer the Create Company Tag, Create Team Tag, or Create Teammate Tag endpoints when you need to target a specific scope. Requires the tags:write scope.
Inputs
namestringrequired
Name of the tag to create. Maximum length is 64 characters.
descriptionstring
Optional description of the tag's purpose.
highlightstring
Highlight color of the tag. One of: grey, pink, red, orange, yellow, green, light-blue, blue, purple.one of greypinkredorangeyellowgreenlight-bluebluepurple
is_visible_in_conversation_listsboolean
Whether the tag is visible in conversation lists. Defaults to false.default false
Also accepts schema_version and tool_version to pin a version.
front_edit_draftEdit an existing draft message in Front.Write
Edit Draft
Edit an existing draft message in Front. Requires scope drafts:write.
Inputs
bodystringrequired
Body of the draft.
channel_idstringrequired
ID of the channel from which the draft will be sent, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
message_idstringrequired
The unique Front identifier for the draft to edit, e.g. msg_123.
versionstringrequired
Version of the draft being edited, used for optimistic concurrency control.
author_idstring
ID of the teammate on behalf of whom the draft is edited, e.g. tea_123.
bccarray
List of the recipient handles who will receive a blind copy of the message once the draft is sent.
ccarray
List of recipient handles who will receive a copy of the message once the draft is sent.
modestring
Mode of the draft to update. Can only be 'shared' (visible to all teammates with access to the conversation) when editing.one of shared
quote_bodystring
Body for the quote that the message is referencing. Only available on email channels.
should_add_default_signatureboolean
Whether Front should try to resolve a signature for the message. Ignored if signature_id is set. Defaults to false.
signature_idstring
ID of the signature to attach to this draft. If null, no signature is attached.
subjectstring
Subject of the draft.
toarray
List of recipient handles who will receive the message once the draft is sent.
Also accepts schema_version and tool_version to pin a version.
front_import_messageImport a message into a Front inbox without sending it through a live channel.Write
Import Message
Import a message into a Front inbox without sending it through a live channel. Use this for historical conversations or non-standard sources (e.g. web form submissions) rather than for sending new outbound messages, which should use Send Message instead. Requires scope messages:write.
Inputs
bodystringrequired
Body of the message.
created_atintegerrequired
Unix timestamp (seconds) of when the message was sent or received.
external_idstringrequired
External identifier of the message. Front will not import two messages with the same external ID.
inbox_idstringrequired
The unique Front identifier for the inbox to import the message into, e.g. inb_123.
metadata_is_inboundbooleanrequired
Determines if the message is received (inbound) or sent (outbound) by you.
sender_handlestringrequired
Handle of the sender, any string that uniquely identifies them (e.g. an email address or phone number). For phone numbers, include a country code preceded by a plus sign (e.g. +33) or it will be normalized to the USA (+1).
toarrayrequired
List of recipient handles who received this message.
assignee_idstring
ID of the teammate who will be assigned to the conversation, e.g. tea_123.
bccarray
List of recipient handles who received a blind copy of this message.
body_formatstring
Format of the message body. Can be markdown (default) or html. Only applicable for email type messages.one of htmlmarkdowndefault markdown
ccarray
List of recipient handles who received a copy of this message.
conversation_idstring
If supplied, Front threads this message into the conversation with the given ID. Supplying this nullifies metadata_thread_ref completely.
metadata_is_archivedboolean
Determines if the message is archived after import. Defaults to true.
metadata_should_skip_rulesboolean
Determines if automation rules should be skipped for this import. Defaults to true.
metadata_thread_refstring
Reference used to thread messages together. If omitted, Front threads by sender instead. Unique to importing historical messages.
sender_author_idstring
ID of the teammate who authored the message, e.g. tea_123. Ignored if the message is inbound.
sender_namestring
Name of the sender.
subjectstring
Subject of the message.
tagsarray
List of tag names to add to the conversation.
typestring
Type of the message to import. Default is email.one of emailsmsintercomcustomdefault email
Also accepts schema_version and tool_version to pin a version.
front_receive_messageReceive a custom message in Front.Write
Receive Custom Message
Receive a custom message in Front. Available for custom channels ONLY. Requires scope messages:write.
Inputs
bodystringrequired
Body of the message.
channel_idstringrequired
The custom channel ID, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
sender_handlestringrequired
Handle of the sender, any string that uniquely identifies them. For phone numbers, include a country code preceded by a plus sign (e.g. +33) or it will be normalized to the USA (+1).
body_formatstring
Format of the message body. Can be markdown (default) or html.one of htmlmarkdowndefault markdown
metadata_thread_refstring
Reference used to thread messages together. If omitted, Front threads by sender instead. Unique to custom channels.
sender_contact_idstring
ID of the contact in Front corresponding to the sender, e.g. crd_123.
sender_namestring
Name of the sender.
subjectstring
Subject of the message.
Also accepts schema_version and tool_version to pin a version.
front_reply_to_conversationReply to a conversation by sending a message and appending it to the conversation.Write
Reply To Conversation
Reply to a conversation by sending a message and appending it to the conversation. Required scope: messages:send.
Inputs
bodystringrequired
Body of the message.
conversation_idstringrequired
The conversation ID.
archiveboolean
Archive the conversation right when sending the message. True by default.
author_idstring
ID of the teammate on behalf of whom the answer is sent.
bccarray
List of the recipient handles who will receive a copy of this message.
ccarray
List of the recipient handles who will receive a copy of this message.
channel_idstring
Channel ID the message is sent from.
quote_bodystring
Body for the quote that the message is referencing. Only available on email channels.
sender_namestring
Name used for the sender info of the message.
should_add_default_signatureboolean
Whether or not Front should try to resolve a signature for the message. Only applies to email channels and is ignored if signature_id is included or if author_id is omitted.
signature_idstring
ID of the signature to attach to this draft. Only supported for email channels; using this on other channel types returns a 403 forbidden error. If null, no signature is attached.
subjectstring
Subject of the message for email message.
tag_idsarray
List of tag IDs to add to the conversation.
textstring
Text version of the body for email messages.
toarray
List of the recipient handles who will receive this message.
Also accepts schema_version and tool_version to pin a version.
front_send_messageSend a new outbound message from a Front channel.Write
Send Message
Send a new outbound message from a Front channel. This is one of the ways to create a new conversation; the resulting conversation supports both messages and comments. Requires scope messages:send. At least one of To, CC, or BCC must be provided.
Inputs
bodystringrequired
Body of the message.
channel_idstringrequired
The sending channel ID, e.g. cha_123. Alternatively, supply the sending channel's address as a resource alias.
archiveboolean
Archive the conversation right when sending the message. Defaults to true.
author_idstring
ID of the teammate on behalf of whom the message is sent, e.g. tea_123.
bccarray
List of recipient handles who will receive a blind copy of this message. At least one of to, cc, or bcc is required.
ccarray
List of recipient handles who will receive a copy of this message. At least one of to, cc, or bcc is required.
sender_namestring
Name used for the sender info of the message.
should_add_default_signatureboolean
Whether Front should try to resolve a signature for the message. Only applies to email channels and is ignored if signature_id is set or author_id is omitted. Defaults to false.
signature_idstring
ID of the signature to attach to this message. Only supported for email channels; using it on other channel types returns a 403 error.
subjectstring
Subject of the message, for email messages.
tag_idsarray
List of tag IDs to add to the resulting conversation.
textstring
Text version of the body, for email messages.
toarray
List of recipient handles (e.g. email addresses) who will receive this message. At least one of to, cc, or bcc is required.
Also accepts schema_version and tool_version to pin a version.
front_update_contactUpdate an existing contact's details by its Front contact ID.Write
Update Contact
Update an existing contact's details by its Front contact ID.
Inputs
contact_idstringrequired
The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
custom_fieldsobject
Custom fields for this contact, keyed by the custom field name defined in the Front UI. Omit to leave existing custom fields unchanged; include all custom fields you want to keep when updating any of them.
descriptionstring
Contact description.
linksarray
List of links associated with the contact.
list_namesarray
List of contact list names the contact belongs to. Missing lists will be created automatically.
namestring
Contact name.
Also accepts schema_version and tool_version to pin a version.
front_update_conversationUpdate a conversation's assignee, inbox, status, tags, task description, or due date.Write
Update Conversation
Update a conversation's assignee, inbox, status, tags, task description, or due date. Required scope: conversations:write.
Inputs
conversation_idstringrequired
The conversation ID.
assignee_idstring
ID of the teammate to assign the conversation to. Set to null to unassign.
custom_fieldsobject
Custom fields for this conversation, sent as an object of key:value pairs. If you want to update custom fields, include all custom fields, not just the ones you want to change, or the others will be erased.
descriptionstring
Description of the task. Only allowed on task conversations. Set to null to clear.
due_atnumber
Unix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed on task conversations. Set to null to clear.
inbox_idstring
ID of the inbox to move the conversation to.
statusstring
New status of the conversation.one of archivedopendeletedspam
status_idstring
Unique identifier of the status to set the conversation to. Only one of status and status_id should be provided. Ticketing must be enabled for the company to use this field.
tag_idsarray
List of all the tag IDs replacing the old conversation tags.
Also accepts schema_version and tool_version to pin a version.
front_update_conversation_assigneeAssign or unassign a conversation to a teammate.Write
Update Conversation Assignee
Assign or unassign a conversation to a teammate. Required scope: conversations:write.
Inputs
assignee_idstringrequired
ID of the teammate to assign the conversation to. Set to null to unassign.
conversation_idstringrequired
The conversation ID.
Also accepts schema_version and tool_version to pin a version.
front_update_tagUpdate an existing Front tag's name, description, highlight color, parent tag, or visibility.Write
Update Tag
Update an existing Front tag's name, description, highlight color, parent tag, or visibility. Only the fields provided are changed. Requires the tags:write scope.
- Idempotent
Inputs
tag_idstringrequired
The unique Front identifier of the tag to update, e.g. 'tag_123'.
descriptionstring
New description of the tag's purpose.
highlightstring
New highlight color of the tag. One of: grey, pink, red, orange, yellow, green, light-blue, blue, purple.one of greypinkredorangeyellowgreenlight-bluebluepurple
is_visible_in_conversation_listsboolean
Whether the tag is visible in conversation lists.
namestring
New name for the tag. Maximum length is 64 characters.
parent_tag_idstring
ID of the parent tag to nest this tag under. Set to null to remove the parent tag.
Also accepts schema_version and tool_version to pin a version.
front_update_teammateUpdate a teammate's username, name, or availability status in Front.Write
Update Teammate
Update a teammate's username, name, or availability status in Front.
Inputs
teammate_idstringrequired
The teammate ID. Alternatively, you can supply an email as a resource alias.
first_namestring
New first name.
is_availableboolean
New availability status.
last_namestring
New last name.
usernamestring
New username. It must be unique and can only contain lowercase letters, numbers and underscores.
Also accepts schema_version and tool_version to pin a version.
front_delete_contactPermanently delete a contact by its Front contact ID.Destructive
Delete Contact
Permanently delete a contact by its Front contact ID.
Inputs
contact_idstringrequired
The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
Also accepts schema_version and tool_version to pin a version.
front_delete_draftPermanently delete a draft message in Front.Destructive
Delete Draft
Permanently delete a draft message in Front. Requires the current draft version and scope drafts:delete.
- Idempotent
Inputs
draft_idstringrequired
The unique Front identifier for the draft to delete, e.g. msg_123.
versionstringrequired
Version of the draft to delete, used to prevent deleting a draft that has since changed. Obtain this from a prior Get Message call.
Also accepts schema_version and tool_version to pin a version.
front_delete_tagPermanently delete a tag from Front by its ID.Destructive
Delete Tag
Permanently delete a tag from Front by its ID. This removes the tag from all conversations it was applied to and cannot be undone. Requires the tags:delete scope.
- Idempotent
Inputs
tag_idstringrequired
The unique Front identifier of the tag to delete, e.g. 'tag_123'.
Also accepts schema_version and tool_version to pin a version.
front_remove_conversation_tagRemove one or more tags from a conversation.Destructive
Remove Conversation Tag
Remove one or more tags from a conversation. Required scope: conversations:write.
Inputs
conversation_idstringrequired
The conversation ID.
tag_idsarrayrequired
Tag IDs to remove from the conversation.
Also accepts schema_version and tool_version to pin a version.

Setup

Install the SDK

Set your credentials

Create the Front connection

Authorize a user and make your first call

Tools

Call it

Returns

Get Account

Inputs

Get Channel

Inputs

Get Comment

Inputs

Get Contact

Inputs

Get Conversation

Inputs

Get Inbox

Inputs

Get Message

Inputs

Get Message Template

Inputs

Get Tag

Inputs

Get Teammate

Inputs

List Accounts

Inputs

List Channels

Inputs

List Contact Groups

Inputs

List Contact Notes

Inputs

List Contacts

Inputs

List Conversation Comments

Inputs

List Conversation Messages

Inputs

List Conversations

Inputs

List Custom Fields

Inputs

List Inbox Channels

Inputs

List Inbox Conversations

Inputs

List Inboxes

Inputs

List Knowledge Base Articles

Inputs

List Knowledge Bases

Inputs

List Links

Inputs

List Message Templates

Inputs

List Tags

Inputs

List Teammate Signatures

Inputs

List Teammates

Inputs

List Teams

Inputs

Search Conversations

Inputs

Add Contact Handle

Inputs

Add Contact Note

Inputs

Add Conversation Comment

Inputs

Add Conversation Tag

Inputs

Create Contact

Inputs