NAV Navbar
  • Introduction
  • Set Up
  • Sending Messages
  • General Notes
  • Introduction

    To help get you started with the Channels API, this walkthrough should act as a valuable sample to kick off your development. If you have any additional questions, please reach out to us at api@frontapp.com!

    Set Up

    1. Fill out the form for your sample channel. Because it's for a sample channel, your answers don't need to be too in-depth. Here are our suggestions for the sample channel.

    Field Your Answer
    Company Name Your company's name.
    Contact Name Your name.
    Contact Email Your email.
    Name of channel Sample Channel.
    Webhook URL Our mock server we've set up for you:
    https://60148d1b-b353-4438-9b63-7cd8b0f9f21c.mock.pstmn.io
    Description of Channel This is a sample channel.
    Compose Check this.
    Reply Check this.
    Channel Contact Type Choose whichever.
    Attachments Check this.
    Attachment Types Choose whichever.
    Icon for your channel Leave empty. It's an optional field.
    Auth Method API Token. For the sample, you can fake a token with any string. The token won't be verified in the sample channel.
    OAuth fields Leave blank

    2. Front will create a new Channel Type for you. A Channel Type is an entity that represents the configuration you sent to Front in the previous step. When users create a new Channel, they are creating an instance of your Channel Type.

    3. Once you have received your Channel Type’s API key and Channel Type ID, keep them safe! You’ll need them to make requests to Front’s API.

    4. In the Postman collection, input your Channel Type API Key (secretKey) and Channel Type ID (channelTypeId) as environment variables.

    Environment Variables

    5. In Front, add your new channel. (Settings > Inboxes > Add a team inbox)

    6. When the new channel is added, Front sends a request to the callback URL of your Channel Type, with the authentication payload shown in the Postman collection.

    Channel Settings

    Sending Messages

    1. Use the inbound_messages endpoint to send a message to Front. Observe that the endpoint generated depends on the channel ID. Sending Messages 1

    2. Respond to the message in Front - The request body sent to your callback server will match the example request body in the Postman collection.

    Sending Messages 2

    Sending Messages 3

    3. Import a message using outbound_message endpoint

    Sending Messages 4

    Sending Messages 5

    General Notes