With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
Â
External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
Â
Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
Â
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
Operations
Articles
Everything about your Articles
Operations
Internal Articles
Everything about your Internal Articles
Operations
Away Status Reasons
Everything about your away status reasons
Operations
Companies
Everything about your Companies
Operations
Contacts
Everything about your contacts
Operations
Conversations
Everything about your Conversations
Operations
Custom Object Instances
Everything about your Custom Object instances.
Permission Requirements
From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.
Operations
Data Attributes
Everything about your Data Attributes
Operations
Data Events
Everything about your Data Events
Operations
Data Event
Data events are used to notify Intercom of changes to your data.
typestring
The type of the object
Value"event"
Example: "event"
event_namestringrequired
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.
Example: "invited-friend"
created_atinteger(date-time)required
The time the event occurred as a UTC Unix timestamp
Example: 1671028894
user_idstring
Your identifier for the user.
Example: "314159"
idstring
Your identifier for a lead or a user.
Example: "8a88a590-e1c3-41e2-a502-e0649dbf721c"
intercom_user_idstring
The Intercom identifier for the user.
Example: "63a0979a5eeebeaf28dd56ba"
emailstring
An email address for your user. An email should only be used where your application uses email to uniquely identify users.
You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json.
When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.
With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).
NB: For the JSON object types, please note that we do not currently support nested JSON structure.
Type
Description
Example
String
The value is a JSON String
"source":"desktop"
Number
The value is a JSON Number
"load": 3.67
Date
The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone.
"contact_date": 1392036272
Link
The value is a HTTP or HTTPS URI.
"article": "https://example.org/ab1de.html"
Rich Link
The value is a JSON object that contains url and value keys.
The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99.
"price": {"amount": 34999, "currency": "eur"}
Lead Events
When submitting events for Leads, you will need to specify the Lead's id.
Metadata behaviour
We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
There might be up to 24 hrs delay when you send a new metadata for an existing event.
Event de-duplication
The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.
Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.
HTTP API Responses
Successful responses to submitted events return 202 Accepted with an empty body.
Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
Events sent about users that cannot be found will return a 404 Not Found.
Event lists containing duplicate events will have those duplicates ignored.
Server errors will return a 500 response code and may contain an error message in the body.
Headers
Intercom-Versionstring(intercom_version)
Intercom API version. By default, it's equal to the version set in the app package.
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.
Example: "invited-friend"
created_atinteger(date-time)required
The time the event occurred as a UTC Unix timestamp
Example: 1671028894
user_idstring
Your identifier for the user.
Example: "314159"
idstringrequired
The unique identifier for the contact (lead or user) which is given by Intercom.
Example: "8a88a590-e1c3-41e2-a502-e0649dbf721c"
emailstring
An email address for your user. An email should only be used where your application uses email to uniquely identify users.
Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days
The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.
Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.
Headers
Intercom-Versionstring(intercom_version)
Intercom API version. By default, it's equal to the version set in the app package.
A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example updated-plan.