API token

https://app.frontapp.com/settings/tools/api

Create a new Front token
Save as this integration's API token

Bot teammate

https://app.frontapp.com/settings/global/teammates/list

Find or create a teammate
This integration will use the teammate for all bot conversations
Save the email address as this integration's bot teammate email

Channel

https://app.frontapp.com/settings/home

Find or create an inbox
Add a new custom channel
- Enter a descriptive name
Under "API endpoints", add an outgoing URL
- Use this integration's webhook URL
Under "API endpoints", find "cha_xxx" in the incoming URL
- Save as this integration's channel ID

Webhook

https://app.frontapp.com/settings/integrations/native/edit/webhooks/settings

Enable the webhook integration
Turn on send full event details

Rule

https://app.frontapp.com/settings/home

Add a new rule
- Enter a descriptive name
- Make sure rule is active
Add 8 "When..." triggers
- Inbound message is received
- Outbound message is sent (new conversation)
- Outbound reply is sent (existing conversation)
- New comment is added from any teammate (no body condition)
- Assignee is changed to any teammate
- Assignee is removed
- Any tag is added
- Any tag is removed
[Optional] Add "If..." condition
- Conversation is in your desired Inbox
Add 1 "Then..." action
- "Send to a Webhook": Paste this integration's webhook URL

Meya Partner Channel

To use the Meya Partner Channel you'll need to generate a new token for
Front, and set it as the Front integration client_token.

Create a new client token using your app ID, integration ID, and a client
secret that you generate using a password generator
- Token format: {{app_id}}:{{integration_id}}:{{client_secret}},
  e.g. app-123:integration.front:xyz789
- client_secret must be alphanumeric with length 10 to 20 characters
Now go to your Front inbox settings, and add the Meya Partner Channel
using this client token

Element details

type: meya.front.integration
class: FrontIntegration
path: /meya/front/integration/integration.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
enabled	Enables the integration, allowing it to process events and HTTP/WS entries.	○	○	true	bool
filter		○	○	rx_sub: true rx: true tx: "\nmeya.event.entry.interactive\nOR meya.csp.event\nOR meya.button.event.click\n OR meya.form.event.submit\n" tx_pub: true	IntegrationFilter
verify_token	The token to be verified for each incoming request. You need to add the `verify_token=YOUR_TOKEN` query parameter to integration's webhook URL.	○	○	null	str
max_attachment_size	Controls maximum attachment size supported by the integration in bytes.	○	○	15728640	int
markdown	The markdown features that are supported by this integration. Check the Markdown guide for more info.	○	○	false	list bool
typing	When set to `false`, all typing indicators received by the integration will be ignored.	○	○	true	bool
avatar		○	○	crop: circle	CspIntegrationAvatar
agent_command_prefix		○	○	"/"	str
transcript		○	○	count: 25 user_prefix: user bot_prefix: bot agent_prefix: agent note_prefix: 📝	CspIntegrationTranscript
agent		○	○	name: avatar:	AgentSpec
api_token		◉	○		str
bot_teammate_email		◉	○		str
channel_id		◉	○		str
integration_mode		○	○	"tracking"	FrontIntegrationMode
unlink_thread_status	The set of Front statuses that will unlink the Meya thread from the Front conversation. When the Meya thread is unlinked, then the integration will no longer send events to Front.	○	○	[]	list
unassign_mode		○	○	"bot"	str
client_token		○	○	null	str
request_attempts	Controls the number of attempts of each API request on the conversation create component.	○	○	4	int
request_timeout	Controls Front API request timeout.	○	○	3	Real

Usage reference

Basic

type: meya.front.integration
api_token: STRING
bot_teammate_email: STRING
channel_id: STRING

Full

type: meya.front.integration
spec:
  type: STRING
  data:
    STRING: ANY
  timeout: 123
  trigger_when: ANY
enabled: false
filter:
  rx_sub: STRING
  rx: STRING
  tx: STRING
  tx_pub: STRING
verify_token: STRING
max_attachment_size: 123
markdown:
  - format|linkify|breaks|typographer
typing: false
avatar:
  crop: circle|square
agent_command_prefix: STRING
transcript:
  count: 123
  user_prefix: STRING
  bot_prefix: STRING
  agent_prefix: STRING
  note_prefix: STRING
agent:
  name: full|first|first_initial|first_last_initial|first_initial_last_initial
  avatar:
    image: STRING
    crop: circle|square
    monogram: full|first|first_initial|first_last_initial|first_initial_last_initial
api_token: STRING
bot_teammate_email: STRING
channel_id: STRING
integration_mode: tracking|ticketing
unlink_thread_status:
  - trash
unassign_mode: STRING
client_token: STRING
request_attempts: 123
request_timeout: 123