Front

Send messages, list conversations, and manage tags in Front.

Customer supportAPI key21 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (21)
findConversation
sendMessage
addComment
addContactHandle
addConversationLinks
addConversationTags
assignUnassignConversation
createAccount
createContact
createDraft
createDraftReply
createLink
findAccount
findContact
removeContactHandle
removeConversationLinks
sendReply
updateAccount
updateContact
updateConversation
updateLink
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("front", "findConversation", {
    "q": "<query>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Front answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "front-findconversation",
  name: "Front: Find Conversation",
  description: "Calls Front when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("front", {
      "action": "findConversation",
      "q": "<query>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/front/findConversation" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"q":"<query>"}}'

Actions

findConversationin catalog

Find Conversation. Find a conversation by search filters such as subject, participants, tags, inbox, etc.

Also accepted as find-conversation.

Input	Type	Description
`q`required	text	Front query string (e.g. subject:"Order", tag_ids:tag_123, inbox_id:inb_456, etc.). See https://dev.frontapp.com/docs/search-1
`limit`optional	number	Maximum number of conversations to return.
`page_token`optional	text	Token for pagination.

sendMessagein catalog

Send Message. Send a new message (starts a conversation) with subject, recipients, body, attachments, tags, etc.

Also accepted as send_message.

Input	Type	Description
`channel_id`required	id (picked from your account)	Select the channel
`to`required	array	List of recipient handles (email addresses, etc.).
`cc`optional	array	List of CC recipient handles.
`bcc`optional	array	List of BCC recipient handles.
`subject`optional	text	The subject of the message.
`body`required	long text	The body of the message.
`attachments`optional	array	List of attachment URLs.
`tag_ids`optional	ids (picked from your account)	Select one or more tags

addComment

Add Comment. Add a comment (internal note) to a conversation in Front.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`author_id`required	id (picked from your account)	Select the teammate
`body`required	long text	The content of the comment.

addContactHandle

Add Contact Handle. Add a handle (email, phone number, etc.) to an existing Contact.

Input	Type	Description
`contact_id`required	id (picked from your account)	Select the contact
`handle_type`required	one of "email" \| "phone" \| "twitter" \| "facebook" \| "intercom" \| "front_chat" \| "custom"	Type of handle to add.
`handle_value`required	text	The value of the handle (e.g., email address, phone number).

addConversationLinks

Add Conversation Links. Link external references (URLs) to a conversation.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`link_ids`optional	ids (picked from your account)	Select one or more links

addConversationTags

Add Conversation Tags. Add one or more tags to a conversation.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`tag_ids`optional	ids (picked from your account)	Select one or more tags

assignUnassignConversation

Assign/Unassign Conversation. Assign a conversation to a teammate or remove assignment.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`assignee_id`required	id (picked from your account)	Select the teammate

createAccount

Create Account. Create a new account in Front.

Input	Type	Description
`name`required	text	The name of the account to create.
`description`optional	text	A description for the account.
`domains`optional	array	List of domains associated with the account.
`external_id`optional	text	An external identifier for the account.
`custom_fields`optional	JSON	Custom fields for this account, as a JSON object.

createContact

Create Contact. Create a new contact in Front.

Input	Type	Description
`name`optional	text	The name of the contact.
`description`optional	text	A description for the contact.
`handles`required	array	List of contact handles (e.g., email, phone).
`avatar_url`optional	file	URL of the contact’s avatar image.
`links`optional	array	List of URLs associated with the contact.
`group_names`optional	array	List of group names to associate with the contact.
`list_names`optional	array	List of contact list names this contact belongs to. Front will create any that do not exist.
`custom_fields`optional	JSON	Custom fields for this contact, as a JSON object (e.g., {"CRM ID": "12345"}).

createDraft

Create Draft. Create a draft message in Front.

Input	Type	Description
`channel_id`required	id (picked from your account)	Select the channel
`to`required	array	List of recipient handles (email addresses, etc.).
`cc`optional	array	List of CC recipient handles.
`bcc`optional	array	List of BCC recipient handles.
`subject`optional	text	The subject of the draft.
`body`required	long text	The body of the draft message.
`attachments`optional	array	List of attachment URLs.
`mode`required	one of "private" \| "shared"	Mode of the draft reply
`signature_id`optional	text	The ID of the signature to use for the draft reply (if applicable).
`should_add_default_signature`optional	boolean	Whether to append the default signature to the draft reply (if applicable).

createDraftReply

Create Draft Reply. Create a draft reply to an existing conversation (subject/quote etc.) without sending immediately.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`body`required	long text	The content of the draft reply.
`subject`optional	text	The subject of the draft reply (for email channels).
`author_id`required	id (picked from your account)	Select the teammate
`channel_id`required	id (picked from your account)	Select the channel
`to`optional	array	List of recipient handles (email addresses, etc.).
`cc`optional	array	List of CC recipient handles.
`bcc`optional	array	List of BCC recipient handles.
`attachments`optional	array	List of attachment URLs.
`mode`required	one of "private" \| "shared"	Mode of the draft reply
`signature_id`optional	text	The ID of the signature to use for the draft reply (if applicable).
`should_add_default_signature`optional	boolean	Whether to append the default signature to the draft reply (if applicable).

createLink

Create Link. Create a Link in Front (name, external URL).

Input	Type	Description
`name`required	text	The name of the link.
`external_url`required	text	The external URL for the link.
`pattern`optional	text	Optional pattern to match URLs (regex).

findAccount

Find Account. List company accounts and optionally filter by email domain or external ID.

Input	Type	Description
`email_domain`optional	text	Filter accounts by email domain
`external_id`optional	text	Filter accounts by external ID
`limit`optional	number	Maximum number of accounts to return (max 100).
`page_token`optional	text	Token for pagination.
`sort_by`optional	one of "created_at" \| "updated_at"	Field used to sort the accounts.
`sort_order`optional	one of "asc" \| "desc"	Order by which results should be sorted.

findContact

Find Contact. Look up a contact by handle (email, phone, etc.) or other identifying field.

Input	Type	Description
`email`optional	text	Email address to search for.
`phone`optional	text	Phone number to search for.
`custom_query`optional	text	Custom Front query string (advanced).
`limit`optional	number	Maximum number of contacts to return.
`page_token`optional	text	Token for pagination.

removeContactHandle

Remove Contact Handle. Remove a handle (email, phone number, etc.) from an existing Contact.

Input	Type	Description
`contact_id`required	id (picked from your account)	Select the contact
`handle`required	text	The handle to remove.
`source`required	one of "email" \| "phone" \| "twitter" \| "facebook" \| "intercom" \| "front_chat" \| "custom"	The type of the handle to remove.
`force`optional	boolean	If true, the entire contact will be deleted if this is their last handle.

removeConversationLinks

Remove Conversation Links. Remove external links from a conversation in Front.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`links`required	array	List of external URLs to remove from the conversation.

sendReply

Send Reply. Send a reply to a conversation in Front.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`body`required	long text	The content of the reply message.
`author_id`required	id (picked from your account)	Select the teammate
`subject`optional	text	The subject of the reply (for email channels).
`to`optional	array	List of recipient handles (email addresses, etc.).
`cc`optional	array	List of CC recipient handles.
`bcc`optional	array	List of BCC recipient handles.
`channel_id`required	id (picked from your account)	Select the channel
`attachments`optional	array	List of attachment URLs.

updateAccount

Update Account. Update an existing account in Front.

Input	Type	Description
`account_id`required	id (picked from your account)	Select the account
`name`optional	text	The new name for the account.
`description`optional	text	The new description for the account.
`domains`optional	array	List of domains associated with the account.
`custom_fields`optional	JSON	Custom fields to add or update. Existing fields will be preserved.

updateContact

Update Contact. Update an existing contact in Front.

Input	Type	Description
`contact_id`required	id (picked from your account)	Select the contact
`name`optional	text	The new name for the contact.
`description`optional	text	A new description for the contact.
`avatar_url`optional	text	URL of the contact’s avatar image.
`links`optional	array	List of URLs associated with the contact.

updateConversation

Update Conversation. Modify conversation properties: status, assignee, inbox, tags, etc.

Input	Type	Description
`conversation_id`required	id (picked from your account)	Select the conversation
`status`optional	one of "open" \| "archived" \| "deleted"	The new status for the conversation.
`assignee_id`required	id (picked from your account)	Select the teammate
`inbox_id`optional	id (picked from your account)	Select the inbox
`tag_ids`optional	ids (picked from your account)	Select one or more tags

updateLink

Update Link. Update the name or external URL of a Link in Front.

Input	Type	Description
`link_id`optional	id (picked from your account)	Select the link
`name`optional	text	The new name for the link.
`external_url`optional	text	The new external URL for the link.

Details

Id: front
Category: Customer support
Tags: inbox, support, email, team
Package: @activepieces/piece-front@0.1.3
Tier: Community