Front

Documentation >
Apps >
Productivity >
Front

Front¶

Getting Started with Front¶

The Front modules allow you to monitor events and/or list, create, retrieve, update, or delete teams, teammates, inboxes, conversations, messages, contacts, contact groups, and much more in your Front account.

Prerequisites

A Front account

In order to use Front with Ibexa Connect, it is necessary to have a Front account. If you do not have one, you can create a Front account at frontapp.com/signup.

Connecting Front to Ibexa Connect¶

To connect your Front account to Ibexa Connect you need to obtain the JSON Web Token from your Front account.

1. Log in to your Front account.

2. Go to Settings > Plugins & API.

3. Open the API section and click on the New Token button.

4. Select scopes. Select the Shared Resources option (to grant access to all team resources).

5. Click on the Create button.

The created token is now displayed under the Front Tokens section.

6. Click on the created Front token and copy it to your clipboard.

7. Go to Ibexa Connect and open the Front module's Create a connection dialog.

8. Enter the token you have created in step 5 into the JSON Web Token field and click the Continue button to establish a connection.

Webhook¶

Watch Events¶

Triggers when an event occurs in the inboxes of your company by the rules you have set.


Webhook	Allows you to automatically be notified of any incidents occurring in Front without having to constantly poll the API.

Teams¶

List Teams¶

Lists the teams in your company.


Limit	Set the maximum number of teams Ibexa Connect can return during one execution cycle.

Get Teams¶

Displays the details of the team.


Team ID	Enter the ID of the requested team.

Teammates¶

List Teammates¶

Lists the teammates in your company.


Limit	Set the maximum number of teammates Ibexa Connect must return during one execution cycle.

Add Teammates to Team¶

Adds teammates as members of a team.


Team ID	Enter the ID of the team to add the teammate(s) to.
Teammates ID	Enter the ID(s) of all the teammate(s) to add

Get Teammate¶

Fetches the information of a teammate.

Teammates ID or

Alternative Teammate Email

Enter the ID or email of the requested teammate.

Update Teammate¶

Updates the information of a teammate.

Teammates ID or Alternative Teammate Email	Enter the ID or email of the requested teammate.
Username	New username. It must be unique and can only contain lowercase letters, numbers, and underscores.
First Name	Enter the new first name of the teammate.
Last Name	Enter the new last name of the teammate.
Is Available	Availability Status. Choose one of the following status: Yes No Not Defined

Delete Teammates from Team¶

Removes teammates from a team. Removing teammates also removes them from inboxes owned by the team.


Team ID	Enter the ID of the team that has the teammates you want to delete.
Teammate IDs	Enter the ID or email of the teammates to delete.

Inbox¶

List Inboxes¶

List all the inboxes.


Team ID	Enter the ID of the team of the inboxes you want to list.
Limit	Maximum number of the inboxes Ibexa Connect can return during the execution of one cycle.

Create Inbox¶

Creates a team inbox.


Team ID	Enter the ID of the team that you want to create the inbox for.
Teammate IDs	Enter the teammates IDs to give access to this inbox.

Get Inbox¶

Fetches the information of an inbox.


Inbox ID	Enter the ID of the requested inbox.

Add Teammates to Inbox¶

Adds teammates to an inbox. The selected teammates must not already have access to the inbox and must be in the team that owns the inbox. Teammates cannot be added to private inboxes.

Teammates ID or Alternative Teammate Email	Enter the IDs or emails of all the teammates to add to the inbox.
Username	New username of the teammate.
First Name	First name of the teammate.
Last Name	Last name of the teammate.
Is Available	Availability Status. Choose one of the following status: Yes No Not Defined

Delete Teammates from Inbox¶

Removes teammates from a team. Selected teammates must currently have access to the inbox to be removed. You cannot remove teammates from private inboxes.


Team ID	Enter the ID of the team from which you want to remove teammates.
Teammates ID	Enter the ID of all the teammates to be deleted from the inbox.

Channel¶

List Channels¶

Lists all the channels.


Team ID	Enter the ID of the team to list the channels for.
Limit	Maximum number of channels Ibexa Connect will return during one execution cycle.

Create Channel¶

Creates a custom channel linked to the requested inbox.

Channel ID	Enter the ID of the channel to be created.
Name	Name for the channel to be created.
Settings
Webhook URL	Only `custom` type. Enter the URL to which the custom message replies are sent.
Reply Mode	The way the channel can be used to reply a message.
Compose Mode	Enter one of the following: `normal`: Allows to compose new messages from this channel. `unsupported`: Prevents composing a new message. Default is `unsupported`.
Contact Type	The contact type channel uses. It can be only set when creating a channel. Choose one from: `custom` `email` `phone` Default is custom.

Get Channel¶

Fetches the information of a channel.


Inbox ID	Enter the ID of the requested channel.

Update Channel¶

Updates the settings of only a custom channel.

Channel ID	Enter the ID of the channel to be updated.
Name	Name of the channel.
Settings
Webhook URL	Only `custom` type. Enter the URL to which the custom message replies are sent.
Reply Mode	The way the channel can be used to reply a message.
Compose Mode	Enter one of the following: `normal`: Allows to compose new messages from this channel. `unsupported`: Prevents composing a new message Default is `unsupported`.

Conversations¶

List Conversations¶

Lists all the conversations in your company in reverse chronological order (most recently updated first).

Limit

Maximum number of results per page.

The default results per page is 50.

Maximum results per page is 100.

Get Conversations¶

Fetches the information of a conversation.


Conversation ID	Enter the ID of the requested conversation.

Update Conversations¶

Updates a conversation.

Conversation ID	Enter the ID of the conversation to be updated.
Assignee ID	Enter the ID of the teammate to assign the conversation to. Set it to null to unassign.
Inbox ID	Enter the ID of the inbox to move the conversation to.
Status	Enter the new status of the conversation.

List Comments¶

Lists all the comments written in a conversation in reverse chronological order (newest first).


Conversation ID	Enter the ID of the requested conversation you want to list.
Limit	Maximum number of comments Ibexa Connect can list during the execution of one cycle.

Get Comment¶

Fetches the information of a comment.

Enter Comment ID

Select one option for the Comment ID.

Manually: Auto populates the Comment ID field. Enter the ID in the field.
By Selecting: Auto populates the Conversation field. Select the conversation from the drop-down list.

Create Comment¶

Adds a comment to a conversation.


Conversation ID	Enter the ID of the requested conversation. When selected, auto populates the Author ID field.
Author ID	Enter the ID of the teammate creating the comment.
Body	Enter the content of the comment.

Message¶

Get Message¶

Fetches the information of a message.

Enter Message ID

Select one option for the message ID.

Manually: Auto populates the Message ID field. Enter the ID in the field.
By Selecting: Auto populates the Conversation field. Select the conversation from the drop-down list. Once you select the conversation, it auto populates the Message field, and enters the message.

Create Message¶

Sends a new message from a channel. It will create a new conversation.

Conversation ID	Enter the ID of the requested conversation. When selected, it auto populates the Author ID.
To	Enter the ID of the member to receive the message.
Author ID	Enter the ID of the teammate creating the message.
Sender Name	Name of the sender.
Subject	Specifies the message heading.
Body	Enter the complete message text.
Attachments	Binary data of the attached files.
Options	Sending options.
Tags	Label used to classify the conversations.
Archive or Not	Select one of the following: Yes No Not defined

Reply Message¶

Replies to a conversation by sending a message and appending it to the conversation.

Conversation ID	Enter the ID of the conversation.
To	Select the sender's name.
Author ID	Enter the ID of the teammate on behalf of whom the answer is sent.
Sender Name	The name used for the sender info of the message.
Subject	Subject of the message for the email message.
Body	Message text.
Attachments	Binary data of the attached files.
Options	Sending options.
Tags	List of tag names to add to the conversation. Unknown tags will automatically be created.
Archive or Not	Choose one of the following status: Yes No Not Defined

Contact¶

List Contact¶

Lists all the contacts.


Updated After	Select a date after which the contacts are to be listed.
Updated Before	Select a date before which the contacts are to be listed.
Limit	Maximum number of contacts Ibexa Connect will list during the execution of one cycle.

Get Contact¶

Fetches the information of a contact.


Contact ID	Enter the ID or alias of the requested contact.

Create Contact¶

Creates a new contact for the default team.

Contact ID	Enter the ID or alias of the requested contact.
Name	Contact name.
Handles	Add contact handles that are used to deal with the contact.
Description	Contact description.
Is Spammer	Whether or not the contact is marked as a spammer. Yes No Not defined
Links	List of the contact's links.
Group Names	List of all the group names the contact belongs to. It automatically creates missing groups.
Source file
Image File Name	Name of the image.
Data	Any other data about the contact.

Update Contact¶

Updates the information of a contact.

Contact ID	Enter the ID of the contact to be updated.
Name	New contact name.
Description	New contact description.
Is Spammer	Whether or not the contact is marked as a spammer. Yes No Not defined
Links	List of all the links of the contact.
Group Names	List of all the group names the contact belongs to. It automatically creates missing groups.
Source file	Enter or map image file from the previous module (e.g. Dropbox > Get a File). Image File Name Enter the name of the image file. Data Enter or map the file data.

Delete Contact¶

Deletes a contact.


Contact ID	Enter the ID of the contact you want to delete.

Add Note to Contact¶

Adds a new note to a contact.


Contact ID	Enter the ID of the contact that you want to add the note.
Author ID	Enter the ID of the teammate who added the note.
Note	Enter the Note text.

Contact Groups¶

List Contact Groups¶

Lists all the contact groups.

Limit

Maximum number of results per page.

The default list of contact groups per page is 50.

Maximum number of contact groups per page is 100.

Create Contact Groups¶

Creates a new contact group in the default team.


Name	Name of the contact group.

Delete Contact Group

Deletes a contact group. Will not delete the contacts in this group.


Group ID	Enter the ID of all the contact groups to delete.

Add Contact into Group¶

Adds a list of contacts in the requested group.


Group ID	Enter the ID of the requested group.
Contact IDs	Enter the list of IDs or aliases of the contacts to add in the requested group.

Rule¶

List Rules¶

Lists all the rules.


Team ID	Enter the ID of the team to add the rules to.
Limit	Maximum number of rules Ibexa Connect can return during one execution cycle.

Get Rule¶

Fetches the information of a tag.


Rule ID	Enter the ID of the requested rule.

Tags¶

Lists all the tags.


Limit	Enter the maximum number of tags Ibexa Connect must list during the execution of one cycle.

Get Tag¶