Event Model

Event Object

JSON

{
  "event_name" : "invited-friend",
  "created_at": 1389913941,
  "user_id": "342311"
}

JavaScript

// Sufficient to send just the event name
Intercom('trackEvent', 'invited-friend');

Ruby

# create an event as a hash
event = {
  :event_name => "invited-friend",
  :email => current_user.email,
  :created_at => 1391691571
}
intercom.events.create event

PHP

<?php
$event = array(
  "event_name" => "invited-friend",
  "created_at" => 1391691571,
  "user_id" => "314159"
);
$intercom->events->create($event);
?>

Java

Event event = new Event()
  .setEventName("invited-friend")
  .setUserID("1314159");
  .setCreatedAt(currentTimeMillis()/1000L);

Event.create(event);

Event Object

An Event Object describes the event and contains the following fields

Attribute	Required	Description
event_name	yes	The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.
created_at	yes	The time the event occurred as a UTC Unix timestamp
user_id	yes if no email	Your identifier for the user.
id	yes if no email or user_id.	Your identifier for a lead or a user.
email	yes if no user_id	An email address for your user. An email should only be used where your application uses email to uniquely identify users
metadata	no	optional metadata about the event.

The event_name field is processed as follows -

• Names are treated as case insensitive - 'Completed-Order' and 'completed-order' will be considered the same event for your application.
• Periods (.) and dollars ($) in event names are replaced with hyphens. e.g., 'completed.order' will be stored as 'completed-order'.

To avoid confusion we recommend submitting lower case event names that do not contain periods or dollars!

Metadata Object

🚧

Please note that it's currently not possible to segment users or message them based on event metadata. for more information on events and metadata please see here

Sending an event with metadata

cURL

$ curl https://api.intercom.io/events \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H "Content-Type: application/json" -d'
{
  "event_name" : "invited-friend",
  "created_at": 1389913941,
  "user_id": "314159",
  "metadata": {
     "invitee_email": "[email protected]",
     "invite_code": "ADDAFRIEND"
  }
}'

JavaScript

var metadata = {
  invitee_email: '[email protected]',
  invite_code: 'ADDAFRIEND'
};
Intercom('trackEvent', 'invited-friend', metadata);

Ruby

metadata = {
  :invitee_email => '[email protected]',
  :invite_code => 'ADDAFRIEND'
}
intercom.events.create {
  :event_name => "invited-friend",
  :email => current_user.email,
  :created_at => 1391691571,
  :metadata => metadata
}

PHP

<?php
$metadata = array(
  "invitee_email" => "[email protected]",
  "invite_code" => "ADDAFRIEND"
);
$intercom->events->create(array(
  "event_name" => "invited-friend",
  "created_at" => 1391691571,
  "user_id" => "314159",
  "metadata" => $metadata
));
?>

Java

Event event = new Event()
  .setEventName("invited-friend")
  .setUserID("314159")
  .putMetadata("invite_mail", "[email protected]")
  .putMetadata("invite_code", "ADDAFRIEND")
  .putMetadata("found_date", currentTimeMillis()/1000L);

Event.create(event);

Metadata can be used to submit an event with extra key value data. Each event can contain up to five metadata key values.

Some use cases for event metadata are -

• Linking an event back to a page in your website.
• Describing before and after values for a subscription plan change.
• Sending contextual information about an online order, a booking.

See the section 'Metadata Types' for more information on the kinds of metadata you can send.