Home
/
REST API Reference
/
Models
/
Activity Log

Intercom API (2.13)

The Intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

AI Content

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

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 Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket States

Everything about your ticket states

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Activity Log

Activities performed by Admins.

idstring

The id representing the activity.

Example: "6"
performed_byobject

Details about the Admin involved in the activity.

metadataobject or null(Activity Log Metadata)

Additional data provided about Admin activity.

created_atinteger(date-time)

The time the activity was created.

Example: 1671028894
activity_typestring
Enum"admin_assignment_limit_change""admin_away_mode_change""admin_deletion""admin_deprovisioned""admin_impersonation_end""admin_impersonation_start""admin_invite_change""admin_invite_creation""admin_invite_deletion""admin_login_failure"
Example: "app_name_change"
activity_descriptionstring

A sentence or two describing the activity.

Example: "Admin updated the app's name to \"My App\"."
{
  "id": "6",
  "performed_by": {
    "type": "admin",
    "id": "1295",
    "email": "john@example.com",
    "ip": "198.51.100.255"
  },
  "metadata": {
    "sign_in_method": "email_password",
    "external_id": "70",
    "away_mode": true,
    "away_status_reason": "😌 On a break",
    "reassign_conversations": false,
    "source": "admin update from web - Admin id: 93",
    "auto_changed": false,
    "update_by": 93,
    "update_by_name": "Joe Example"
  },
  "created_at": 1671028894,
  "activity_type": "app_name_change",
  "activity_description": "Admin updated the app's name to \"My App\"."
}

Paginated Response

A paginated list of activity logs.

typestring

String representing the object's type. Always has the value activity_log.list.

Example: "activity_log.list"
pagesobject or null(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

activity_logsArray of objects or null(Activity Log)

An array of activity logs

{
  "type": "activity_log.list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "activity_logs": [
    { … }
  ]
}

Activity Log Metadata

Additional data provided about Admin activity.

sign_in_methodstring or null

The way the admin signed in.

Example: "email_password"
external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "70"
away_modeboolean or null

The away mode status which is set to true when away and false when returned.

Example: true
away_status_reasonstring or null

The reason the Admin is away.

Example: "😌 On a break"
reassign_conversationsboolean or null

Indicates if conversations should be reassigned while an Admin is away.

Example: false
sourcestring or null

The action that initiated the status change.

Example: "admin update from web - Admin id: 93"
auto_changedstring or null

Indicates if the status was changed automatically or manually.

Example: false
update_byinteger or null

The ID of the Admin who initiated the activity.

Example: 93
update_by_namestring or null

The name of the Admin who initiated the activity.

Example: "Joe Example"
{
  "sign_in_method": "email_password",
  "external_id": "70",
  "away_mode": true,
  "away_status_reason": "😌 On a break",
  "reassign_conversations": false,
  "source": "admin update from web - Admin id: 93",
  "auto_changed": false,
  "update_by": 93,
  "update_by_name": "Joe Example"
}