Home
/
REST API Reference
/
Jobs

Intercom API (Unstable)

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

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 Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Jobs

Everything about jobs

Operations

Jobs

Jobs are tasks that are processed asynchronously by the Intercom system after being enqueued via the API. This allows for efficient handling of operations that may take time to complete, such as data imports or exports. You can check the status of your jobs to monitor their progress and ensure they are completed successfully.

typestring

The type of the object

Value"job"
idstringrequired

The id of the job that's currently being processed or has completed.

Example: 20
urlstring

API endpoint URL to check the job status.

Example: "https://api.intercom.io/jobs/status/20"
statusstring

The status of the job execution.

Enum"pending""success""failed"
resource_typestring

The type of resource created during job execution.

Example: "ticket"
resource_idstring or null

The id of the resource created during job execution (e.g. ticket id)

Example: 123
resource_urlstring or null

The url of the resource created during job exeuction. Use this url to fetch the resource.

Example: "http://api.intercom.io/tickets/123"
{
  "type": "job",
  "id": 20,
  "url": "https://api.intercom.io/jobs/status/20",
  "status": "pending",
  "resource_type": "ticket",
  "resource_id": 123,
  "resource_url": "http://api.intercom.io/tickets/123"
}

Retrieve job status

Request

Retrieve the status of job execution.

Path
idstringrequired

The unique identifier for the job which is given by Intercom

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: Unstable
curl -i -X GET \
  'https://api.intercom.io/jobs/status/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Unstable'

Responses

Job execution status

Bodyapplication/json
typestring

The type of the object

Value"job"
idstringrequired

The id of the job that's currently being processed or has completed.

Example: 20
urlstring

API endpoint URL to check the job status.

Example: "https://api.intercom.io/jobs/status/20"
statusstring

The status of the job execution.

Enum"pending""success""failed"
resource_typestring

The type of resource created during job execution.

Example: "ticket"
resource_idstring or null

The id of the resource created during job execution (e.g. ticket id)

Example: 123
resource_urlstring or null

The url of the resource created during job exeuction. Use this url to fetch the resource.

Example: "http://api.intercom.io/tickets/123"
Response
application/json
{
  "type": "job",
  "id": "2",
  "status": "success",
  "resource_type": "ticket",
  "resource_id": "20",
  "resource_url": "https://api.intercom.io/tickets/20"
}

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