> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Front

> How to set up the Front connector, plus the actions and events that are available.

![Front](https://stackone-logos.com/api/front/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/front/changelog.md)

[66 actions](#actions) · [20 events](#events) · 2 auth methods

Customer Support
Ticketing
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/front/guides/connector-profile/api-token.md)
>
> Requires a Front API token with appropriate permissions to access the Core API.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/front/guides/connector-profile/oauth-2-0.md)
>
> Recommended for public integrations distributed through the Front App Store. Requires registering an app in Front's deve...

Optionally, configure receiving Events for Front into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/front/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/front/guides/link-account/api-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/front/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounts:delete

accounts:read

accounts:write

channels:read

channels:write

comments:read

comments:write

contacts:delete

contacts:read

contacts:write

conversations:delete

conversations:read

conversations:write

drafts:write

events:\*:read

inboxes:read

inboxes:write

messages:read

messages:send

tags:delete

tags:read

tags:write

teammates:read

teammates:write

teams:read

No scopes found

66 actions

ActionDescriptionRequired scopes

List Conversations`front_list_conversations`

Retrieve a list of conversations from Front in reverse chronological order.

`conversations:read`

Get Conversation`front_get_conversation`

Retrieve a specific conversation by ID from Front.

`conversations:read`

Update Conversation`front_update_conversation`

Update a conversation's properties in Front.

`conversations:write`

Update Conversation Assignee`front_update_conversation_assignee`

Assign or unassign a conversation to a teammate in Front.

`conversations:write`

List Conversation Messages`front_list_conversation_messages`

Retrieve all messages in a conversation from Front.

`messages:read`

List Conversation Comments`front_list_conversation_comments`

Retrieve all comments on a conversation from Front.

`comments:read`

Add Conversation Comment`front_add_conversation_comment`

Add an internal comment to a conversation in Front.

`comments:write`

Add Conversation Tag`front_add_conversation_tag`

Add a tag to a conversation in Front.

`conversations:write`

Remove Conversation Tag`front_remove_conversation_tag`

Remove a tag from a conversation in Front.

`conversations:write`

List Conversation Followers`front_list_conversation_followers`

Retrieve all followers of a conversation from Front.

`teammates:read`

Add Conversation Followers`front_add_conversation_followers`

Add followers to a conversation in Front.

`conversations:write`

Search Conversations`front_search_conversations`

Search for conversations in Front using query filters.

`conversations:read`

Delete Conversation`front_delete_conversation`

Delete a conversation from Front.

`conversations:delete`

List Contacts`front_list_contacts`

Retrieve a list of contacts from Front.

`contacts:read`

Get Contact`front_get_contact`

Retrieve a specific contact by ID from Front.

`contacts:read`

Create Contact`front_create_contact`

Create a new contact in Front.

`contacts:write`

Update Contact`front_update_contact`

Update an existing contact in Front.

`contacts:write`

Delete Contact`front_delete_contact`

Delete a contact from Front.

`contacts:delete`

List Contact Conversations`front_list_contact_conversations`

Retrieve all conversations for a contact from Front.

`conversations:read`

Add Contact Handle`front_add_contact_handle`

Add a new handle (email, phone, etc.) to a contact in Front.

`contacts:write`

Add Contact Note`front_add_contact_note`

Add a note to a contact in Front.

`contacts:write`

Get Authenticated User`front_get_me`

Retrieve the teammate associated with the current API token.

List Teammates`front_list_teammates`

Retrieve a list of teammates from Front.

`teammates:read`

Get Teammate`front_get_teammate`

Retrieve a specific teammate by ID from Front.

`teammates:read`

Update Teammate`front_update_teammate`

Update a teammate's profile in Front.

`teammates:write`

List Inboxes`front_list_inboxes`

Retrieve a list of inboxes from Front.

`inboxes:read`

Get Inbox`front_get_inbox`

Retrieve a specific inbox by ID from Front.

`inboxes:read`

List Inbox Conversations`front_list_inbox_conversations`

Retrieve conversations in an inbox from Front.

`conversations:read`

List Inbox Channels`front_list_inbox_channels`

Retrieve channels associated with an inbox from Front.

`channels:read`

Create Inbox`front_create_inbox`

Create a new inbox in Front.

`inboxes:write`

List Channels`front_list_channels`

Retrieve a list of channels from Front.

`channels:read`

Get Channel`front_get_channel`

Retrieve a specific channel by ID from Front.

`channels:read`

Update Channel`front_update_channel`

Update a channel's settings in Front.

`channels:write`

Send Message`front_send_message`

Send an outbound message from a channel in Front.

`messages:send`

Create Channel`front_create_channel`

Create a new channel in an inbox in Front.

`channels:write`

List Tags`front_list_tags`

Retrieve a list of tags from Front.

`tags:read`

Get Tag`front_get_tag`

Retrieve a specific tag by ID from Front.

`tags:read`

Create Tag`front_create_tag`

Create a new tag in Front.

`tags:write`

Update Tag`front_update_tag`

Update a tag in Front.

`tags:write`

Delete Tag`front_delete_tag`

Delete a tag from Front.

`tags:delete`

List Tagged Conversations`front_list_tagged_conversations`

Retrieve conversations with a specific tag from Front.

`conversations:read`

List Child Tags`front_list_child_tags`

Retrieve child tags of a parent tag from Front.

`tags:read`

Create Child Tag`front_create_child_tag`

Create a child tag under a parent tag in Front.

`tags:write`

List Accounts`front_list_accounts`

Retrieve a list of accounts from Front.

`accounts:read`

Get Account`front_get_account`

Retrieve a specific account by ID from Front.

`accounts:read`

Create Account`front_create_account`

Create a new account in Front.

`accounts:write`

Update Account`front_update_account`

Update an existing account in Front.

`accounts:write`

Delete Account`front_delete_account`

Delete an account from Front.

`accounts:delete`

List Account Contacts`front_list_account_contacts`

Retrieve contacts associated with an account from Front.

`contacts:read`

List Events`front_list_events`

Retrieve a list of events from Front.

`events:*:read`

Get Event`front_get_event`

Retrieve a specific event by ID from Front.

`events:*:read`

List Conversation Events`front_list_conversation_events`

Retrieve events for a specific conversation from Front.

`events:*:read`

Get Message`front_get_message`

Retrieve a specific message by ID from Front.

`messages:read`

Create Draft`front_create_draft`

Create a draft message which is the first message of a new conversation.

`drafts:write`

Get Unified Credentials`front_unified_get_me`

Get the current Front connection's unified credentials and identity.

IAM Auth Test`front_auth_test`

Validate the current Front API token and return the raw, unmapped GET /me response. Bypasses the unified IAM credentials...

List Unified Groups`front_unified_list_groups`

List unified groups in Front (Front teams / workspaces).

`teams:read`

Get Unified Group`front_unified_get_group`

Get a unified Front group (team) by id.

`teams:read`

List Unified Organizations`front_unified_list_organizations`

List the single Front company tenant as an IAM organization.

Get Unified Organization`front_unified_get_organization`

Retrieve the Front company tenant by id.

List Unified Resource Types`front_unified_list_resource_types`

List unified resource types in Front.

List Unified Resource Users`front_unified_list_resource_users`

List unified resource users in Front (Front team members).

`teams:read`

List Unified Roles`front_unified_list_roles`

List the two-role Front company admin catalog.

Get Unified Role`front_unified_get_role`

Get a unified Front role by id ("admin" or "member").

List Unified Users`front_unified_list_users`

List unified users in Front (Front teammates).

`teammates:read`

Get Unified User`front_unified_get_user`

Get a unified Front user (teammate) by id.

`teammates:read`

## Events

Tags

Select all
|
Clear

Conversations

Messages

Webhooks

No tags found

20 events

EventDescriptionTags

Inbound Message Received`front_webhook_inbound`Manual setup

Fires when an incoming message is received on a conversation. Front event type `inbound`. Delivered via a Front Rule con...

MessagesWebhooks

Outbound Message Sent`front_webhook_outbound`Manual setup

Fires when an outbound message is sent. Front event type `outbound`. Delivered via a Front Rule configured with the "Sen...

MessagesWebhooks

Reply Sent`front_webhook_out_reply`Manual setup

Fires when a reply is sent on a conversation. Front event type `out_reply`. Delivered via a Front Rule configured with t...

MessagesWebhooks

Message Forwarded`front_webhook_forward`Manual setup

Fires when a message is forwarded. Front event type `forward`. Delivered via a Front Rule configured with the "Send to w\...

MessagesWebhooks

Conversation Assigned`front_webhook_assign`Manual setup

Fires when a conversation is assigned to a teammate. Front event type `assign`. Delivered via a Front Rule configured wi...

ConversationsWebhooks

Conversation Unassigned`front_webhook_unassign`Manual setup

Fires when a conversation is unassigned. Front event type `unassign`. Delivered via a Front Rule configured with the "Se...

ConversationsWebhooks

Conversation Archived`front_webhook_archive`Manual setup

Fires when a conversation is archived. Front event type `archive`. Delivered via a Front Rule configured with the "Send...

ConversationsWebhooks

Conversation Reopened`front_webhook_reopen`Manual setup

Fires when a conversation is unarchived. Front event type `reopen`. Delivered via a Front Rule configured with the "Send...

ConversationsWebhooks

Conversation Deleted`front_webhook_trash`Manual setup

Fires when a conversation is moved to trash. Front event type `trash`. Delivered via a Front Rule configured with the "S...

ConversationsWebhooks

Conversation Restored`front_webhook_restore`Manual setup

Fires when a conversation is removed from trash. Front event type `restore`. Delivered via a Front Rule configured with...

ConversationsWebhooks

Conversation Moved`front_webhook_move`Manual setup

Fires when a conversation is moved to a different inbox. Front event type `move`. Delivered via a Front Rule configured...

ConversationsWebhooks

Conversation Tagged`front_webhook_tag`Manual setup

Fires when a tag is added to a conversation. Front event type `tag`. Delivered via a Front Rule configured with the "Sen...

ConversationsWebhooks

Conversation Untagged`front_webhook_untag`Manual setup

Fires when a tag is removed from a conversation. Front event type `untag`. Delivered via a Front Rule configured with th...

ConversationsWebhooks

Comment Added`front_webhook_comment`Manual setup

Fires when a teammate comments on a conversation. Front event type `comment`. Delivered via a Front Rule configured with...

ConversationsWebhooks

Teammate Mentioned`front_webhook_mention`Manual setup

Fires when a teammate is mentioned in a comment. Front event type `mention`. Delivered via a Front Rule configured with...

ConversationsWebhooks

Link Added`front_webhook_link_added`Manual setup

Fires when a link is added to a conversation. Front event type `link_added`. Delivered via a Front Rule configured with...

ConversationsWebhooks

Link Removed`front_webhook_link_removed`Manual setup

Fires when a link is removed from a conversation. Front event type `link_removed`. Delivered via a Front Rule configured...

ConversationsWebhooks

Sending Error`front_webhook_sending_error`Manual setup

Fires when an inbox cannot send a message. Front event type `sending_error`. Delivered via a Front Rule configured with...

MessagesWebhooks

Message Bounce Error`front_webhook_message_bounce_error`Manual setup

Fires when a message cannot be delivered to the recipient. Front event type `message_bounce_error`. Delivered via a Fron...

MessagesWebhooks

Conversation Reminder`front_webhook_reminder`Manual setup

Fires when a conversation is reopened by a reminder. Front event type `reminder`. Delivered via a Front Rule configured...

ConversationsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.