Events

An event is created everytime something interesting is happening in Front. You'll find in the table below the description of all the types of event that exist. Note that if you are looking to receive real-time updates on particular events, we recommend using Webhooks.

Type

Description

Source Types

Target Types

assign

When a conversation is assigned to a teammate

teammate or rule

teammate

unassign

When a conversation is unassigned

teammate or rule

archive

When a conversation is archived

teammate or rule or reminder

reopen

When a conversation is unarchived

teammate or rule

trash

When a conversation is deleted

teammate or rule

restore

When a conversation is removed from trash

teammate or rule

comment

When a teammate comments on a conversation

teammate

comment

mention

When a teammate mention another teammate

teammate

comment

inbound

When an incoming message is received

inboxes

message

outbound

When an outbound message is sent

inboxes

message

move

When a conversation is moved

teammate or rule

inboxes

forward

When a message is forwarded

teammate or rule

message

tag

When a conversation is tagged

teammate or rule

tag

untag

When a conversation is untagged

teammate or rule

tag

link_added

When a Link is added

teammate or rule

link

link_removed

When a Link is removed

teammate or rule

link

sending_error

When an inbox cannot send a message

recipient

message

message_bounce_error

When a message cannot be delivered to the recipient.

recipient

message

reminder

When a conversation is reopen by a reminder

reminder

out_reply

When a reply is sent

inboxes

message

conversations_merged

When two or more conversations are merged

teammate

deleted_conversation_ids

Event Preview

When receiving an event from Front (either via a webhook or via a custom channel callback), you will receive the preview of the event. As the callback URL you provided is public, you should not blindly trust any incoming requests. This is why we're sending only a preview of the event.

An event preview has the exact same structure as the full event except that its source, target and conversation only contain an ID, a link to the resource itself and a type. You can then either request the detailed event or each resources separately by following their respective _links.

Search Parameters

Events support search queries via parameter named q.

Name

Type

Description

types

array

List of the types of events you want to list

before

number (optional)

Timestamp of the max date of the events you want to list. This will filter on the emitted_at timestamp

after

number (optional)

Timestamp of the min date of the events you want to list. This will filter on the emitted_at timestamp

Please note that the emitted_at timestamps that you specify for the before and after parameters refer to when the event was created in Front, and is not the same as the created_at timestamp referring to when a message was actually sent. For example, imagine a message that was sent yesterday, but was only imported into Front today. In this case, the emitted_at timestamp would be today, but the message's created_at timestamp would be yesterday.

Thus, before and after will filter by the emitted_at timestamps, but the results of that filter will be sorted in reverse chronological order by the created_at timestamp before they are returned to you.

Example Event Object

{
  "_links": {
    "self": "https://api2.frontapp.com/events/evt_55c8c149"
  },
  "id": "evt_55c8c149",
  "type": "assign",
  "emitted_at": 1453770984.123,
  "source": {
    "_meta": {
      "type": "rule"
    },
    "data": {
      "_links": {
        "self": "https://api2.frontapp.com/rules/rul_55c8c149",
        "related": {
          "owner": "https://api2.frontapp.com/teams/tim_55c8c149"
        }
      },
      "id": "rul_55c8c149",
      "name": "Important deliveries",
      "actions": [
        "Assign to Leela Turanga"
      ],
      "is_private": false
    }
  },
  "target": {
    "_meta": {
      "type": "teammate"
    },
    "data": {
      "_links": {
        "self": "https://api2.frontapp.com/teammates/tea_55c8c149",
        "related": {
          "inboxes": "https://api2.frontapp.com/teammates/tea_55c8c149/inboxes",
          "conversations": "https://api2.frontapp.com/teammates/tea_55c8c149/conversations"
        }
      },
      "id": "tea_55c8c149",
      "email": "[email protected]",
      "username": "leela",
      "first_name": "Leela",
      "last_name": "Turanga",
      "is_admin": true,
      "is_available": true,
      "is_blocked": false
    }
  },
  "conversation": {
    "_links": {
      "self": "https://api2.frontapp.com/conversations/cnv_55c8c149",
      "related": {
        "events": "https://api2.frontapp.com/conversations/cnv_55c8c149/events",
        "followers": "https://api2.frontapp.com/conversations/cnv_55c8c149/followers",
        "messages": "https://api2.frontapp.com/conversations/cnv_55c8c149/messages",
        "comments": "https://api2.frontapp.com/conversations/cnv_55c8c149/comments",
        "inboxes": "https://api2.frontapp.com/conversations/cnv_55c8c149/inboxes",
        "last_message": "https://api2.frontapp.com/messages/msg_55c8c149"
      }
    },
    "id": "cnv_55c8c149",
    "subject": "You broke my heart, Hubert.",
    "status": "archived",
    "assignee": {
      "_links": {
        "self": "https://api2.frontapp.com/teammates/tea_55c8c149",
        "related": {
          "inboxes": "https://api2.frontapp.com/teammates/tea_55c8c149/inboxes",
          "conversations": "https://api2.frontapp.com/teammates/tea_55c8c149/conversations"
        }
      },
      "id": "tea_55c8c149",
      "email": "[email protected]",
      "username": "leela",
      "first_name": "Leela",
      "last_name": "Turanga",
      "is_admin": true,
      "is_available": true,
      "is_blocked": false
    },
    "recipient": {
      "_links": {
        "related": {
          "contact": "https://api2.frontapp.com/contacts/crd_55c8c149"
        }
      },
      "handle": "[email protected]",
      "role": "to"
    },
    "tags": [
      {
        "_links": {
          "self": "https://api2.frontapp.com/tags/tag_55c8c149",
          "related": {
            "conversations": "https://api2.frontapp.com/tags/tag_55c8c149/conversations",
            "owner": "https://api2.frontapp.com/teams/tim_55c8c149",
            "children": "https://api2.frontapp.com/tags/tag_55c8c149/children"
          }
        },
        "id": "tag_55c8c149",
        "name": "Robots",
        "highlight": "blue",
        "is_private": false,
        "created_at": 0,
        "updated_at": 0
      }
    ],
    "created_at": 1453770984.123,
    "is_private": false
  }
}