Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.intercom.com/docs/references/rest-api/api.intercom.io/ai-content/getexternalpage below:

Retrieve an external page

The intercom API reference.

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

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

Everything about your Admins

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.",

An external source for External Pages that you add to your Fin Content Library.

Always external_page

Default "content_import_source"

Value"content_import_source"

Example: "content_import_source"

The unique identifier for the content import source which is given by Intercom.

Example: 1234

The time when the content import source was last synced.

Example: 1672928610

If you intend to create or update External Pages via the API, this should be set to api.

Enum"api""automatic""manual"

Example: "api"

The status of the content import source.

Default "active"

Enum"active""deactivated"

Example: "active"

The URL of the root of the external source.

Example: "https://help.example.com/"

The time when the content import source was created.

Example: 1672928359

The time when the content import source was last updated.

Example: 1672928610

{
  "type": "content_import_source",
  "id": 1234,
  "last_synced_at": 1672928610,
  "sync_behavior": "api",
  "status": "active",
  "url": "https://help.example.com/",
  "created_at": 1672928359,
  "updated_at": 1672928610
}

This will return a list of the content import sources for the App.

The type of the object - list.

Value"list"

Example: "list"

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

A count of the total number of content import sources.

Example: 1

An array of Content Import Source objects

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 1,
  "data": [
    { … }
  ]
}

External pages that you have added to your Fin Content Library.

Always external_page

Default "external_page"

Value"external_page"

Example: "external_page"

The unique identifier for the external page which is given by Intercom.

Example: "1234"

The title of the external page.

Example: "Getting started with..."

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Example: "https://help.example.com/en/articles/1234-getting-started"

Whether the external page should be used to answer questions by AI Agent.

Example: true

Whether the external page should be used to answer questions by AI Copilot.

Example: true

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

Example: true

Default "en"

Value"en"

Example: "en"

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

The time when the external page was created.

Example: 1672928359

The time when the external page was last updated.

Example: 1672928610

The time when the external page was last ingested.

Example: 1672928610

{
  "type": "external_page",
  "id": "1234",
  "title": "Getting started with...",
  "html": "<p>Hello world!</p>",
  "url": "https://help.example.com/en/articles/1234-getting-started",
  "ai_agent_availability": true,
  "ai_copilot_availability": true,
  "fin_availability": true,
  "locale": "en",
  "source_id": 1234,
  "external_id": "5678",
  "created_at": 1672928359,
  "updated_at": 1672928610,
  "last_ingested_at": 1672928610
}

This will return a list of external pages for the App.

The type of the object - list.

Value"list"

Example: "list"

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

A count of the total number of external pages.

Example: 1

An array of External Page objects

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 1,
  "data": [
    { … }
  ]
}

You can retrieve a list of all content import sources for a workspace.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X GET \
  https://api.intercom.io/ai/content_import_sources \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

The type of the object - list.

Value"list"

Example: "list"

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

A count of the total number of content import sources.

Example: 1

An array of Content Import Source objects

{
  "data": [
    { … },
    { … },
    { … }
  ],
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 3,
  "type": "list"
}

You can create a new content import source by sending a POST request to this endpoint.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

If you intend to create or update External Pages via the API, this should be set to api.

Value"api"

Example: "api"

The status of the content import source.

Default "active"

Enum"active""deactivated"

Example: "active"

The URL of the content import source.

Example: "https://help.example.com"

curl -i -X POST \
  https://api.intercom.io/ai/content_import_sources \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "sync_behavior": "api",
    "url": "https://www.example.com"
  }'

Always external_page

Default "content_import_source"

Value"content_import_source"

Example: "content_import_source"

The unique identifier for the content import source which is given by Intercom.

Example: 1234

The time when the content import source was last synced.

Example: 1672928610

If you intend to create or update External Pages via the API, this should be set to api.

Enum"api""automatic""manual"

Example: "api"

The status of the content import source.

Default "active"

Enum"active""deactivated"

Example: "active"

The URL of the root of the external source.

Example: "https://help.example.com/"

The time when the content import source was created.

Example: 1672928359

The time when the content import source was last updated.

Example: 1672928610

{
  "id": 36,
  "type": "content_import_source",
  "last_synced_at": 1734537261,
  "status": "active",
  "url": "https://www.example.com",
  "sync_behavior": "api",
  "created_at": 1734537261,
  "updated_at": 1734537261
}

You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.

The unique identifier for the content import source which is given by Intercom.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X DELETE \
  'https://api.intercom.io/ai/content_import_sources/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

The unique identifier for the content import source which is given by Intercom.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X GET \
  'https://api.intercom.io/ai/content_import_sources/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

Always external_page

Default "content_import_source"

Value"content_import_source"

Example: "content_import_source"

The unique identifier for the content import source which is given by Intercom.

Example: 1234

The time when the content import source was last synced.

Example: 1672928610

If you intend to create or update External Pages via the API, this should be set to api.

Enum"api""automatic""manual"

Example: "api"

The status of the content import source.

Default "active"

Enum"active""deactivated"

Example: "active"

The URL of the root of the external source.

Example: "https://help.example.com/"

The time when the content import source was created.

Example: 1672928359

The time when the content import source was last updated.

Example: 1672928610

{
  "id": 38,
  "type": "content_import_source",
  "last_synced_at": 1734537265,
  "status": "active",
  "url": "https://support.example.com/us/5",
  "sync_behavior": "api",
  "created_at": 1734537265,
  "updated_at": 1734537265
}

You can update an existing content import source.

The unique identifier for the content import source which is given by Intercom.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

If you intend to create or update External Pages via the API, this should be set to api. You can not change the value to or from api.

Enum"api""automated""manual"

Example: "api"

The status of the content import source.

Default "active"

Enum"active""deactivated"

Example: "active"

The URL of the content import source. This may only be different from the existing value if the sync behavior is API.

Example: "https://help.example.com"

curl -i -X PUT \
  'https://api.intercom.io/ai/content_import_sources/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "sync_behavior": "api",
    "url": "https://www.example.com"
  }'

Always external_page

Default "content_import_source"

Value"content_import_source"

Example: "content_import_source"

The unique identifier for the content import source which is given by Intercom.

Example: 1234

The time when the content import source was last synced.

Example: 1672928610

If you intend to create or update External Pages via the API, this should be set to api.

Enum"api""automatic""manual"

Example: "api"

The status of the content import source.

Default "active"

Enum"active""deactivated"

Example: "active"

The URL of the root of the external source.

Example: "https://help.example.com/"

The time when the content import source was created.

Example: 1672928359

The time when the content import source was last updated.

Example: 1672928610

{
  "id": 39,
  "type": "content_import_source",
  "last_synced_at": 1734537267,
  "status": "active",
  "url": "https://www.example.com",
  "sync_behavior": "api",
  "created_at": 1734537267,
  "updated_at": 1734537267
}

You can retrieve a list of all external pages for a workspace.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X GET \
  https://api.intercom.io/ai/external_pages \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

The type of the object - list.

Value"list"

Example: "list"

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

A count of the total number of external pages.

Example: 1

An array of External Page objects

{
  "data": [
    { … },
    { … },
    { … }
  ],
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 3,
  "type": "list"
}

You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

The title of the external page.

Example: "Getting started with..."

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source.

Example: "https://help.example.com/en/articles/1234-getting-started"

Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.

Default false

Example: true

Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.

Default false

Example: true

Default "en"

Value"en"

Example: "en"

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

curl -i -X POST \
  https://api.intercom.io/ai/external_pages \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "external_id": "abc1234",
    "html": "<html><body><h1>Test</h1></body></html>",
    "locale": "en",
    "source_id": 44,
    "title": "Test",
    "url": "https://www.example.com"
  }'

Always external_page

Default "external_page"

Value"external_page"

Example: "external_page"

The unique identifier for the external page which is given by Intercom.

Example: "1234"

The title of the external page.

Example: "Getting started with..."

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Example: "https://help.example.com/en/articles/1234-getting-started"

Whether the external page should be used to answer questions by AI Agent.

Example: true

Whether the external page should be used to answer questions by AI Copilot.

Example: true

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

Example: true

Default "en"

Value"en"

Example: "en"

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

The time when the external page was created.

Example: 1672928359

The time when the external page was last updated.

Example: 1672928610

The time when the external page was last ingested.

Example: 1672928610

{
  "id": "21",
  "type": "external_page",
  "title": "Test",
  "html": "<html><body><h1>Test</h1></body></html>",
  "url": "https://www.example.com",
  "ai_agent_availability": true,
  "ai_copilot_availability": true,
  "fin_availability": true,
  "locale": "en",
  "source_id": 44,
  "external_id": "abc1234",
  "created_at": 1734537273,
  "updated_at": 1734537274,
  "last_ingested_at": 1734537274
}

Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.

The unique identifier for the external page which is given by Intercom.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X DELETE \
  'https://api.intercom.io/ai/external_pages/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

Always external_page

Default "external_page"

Value"external_page"

Example: "external_page"

The unique identifier for the external page which is given by Intercom.

Example: "1234"

The title of the external page.

Example: "Getting started with..."

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Example: "https://help.example.com/en/articles/1234-getting-started"

Whether the external page should be used to answer questions by AI Agent.

Example: true

Whether the external page should be used to answer questions by AI Copilot.

Example: true

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

Example: true

Default "en"

Value"en"

Example: "en"

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

The time when the external page was created.

Example: 1672928359

The time when the external page was last updated.

Example: 1672928610

The time when the external page was last ingested.

Example: 1672928610

{
  "id": "22",
  "type": "external_page",
  "title": "My External Content",
  "html": "",
  "url": "https://support.example.com/us/5",
  "ai_agent_availability": true,
  "ai_copilot_availability": true,
  "fin_availability": true,
  "locale": "en",
  "source_id": 45,
  "external_id": "4",
  "created_at": 1734537276,
  "updated_at": 1734537276,
  "last_ingested_at": 1734537276
}

You can retrieve an external page.

The unique identifier for the external page which is given by Intercom.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X GET \
  'https://api.intercom.io/ai/external_pages/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

Always external_page

Default "external_page"

Value"external_page"

Example: "external_page"

The unique identifier for the external page which is given by Intercom.

Example: "1234"

The title of the external page.

Example: "Getting started with..."

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Example: "https://help.example.com/en/articles/1234-getting-started"

Whether the external page should be used to answer questions by AI Agent.

Example: true

Whether the external page should be used to answer questions by AI Copilot.

Example: true

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

Example: true

Default "en"

Value"en"

Example: "en"

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

The time when the external page was created.

Example: 1672928359

The time when the external page was last updated.

Example: 1672928610

The time when the external page was last ingested.

Example: 1672928610

{
  "id": "23",
  "type": "external_page",
  "title": "My External Content",
  "html": "<h1>Hello world</h1><p>This is external content</p>",
  "url": "https://support.example.com/us/6",
  "ai_agent_availability": true,
  "ai_copilot_availability": true,
  "fin_availability": true,
  "locale": "en",
  "source_id": 46,
  "external_id": "5",
  "created_at": 1734537278,
  "updated_at": 1734537278,
  "last_ingested_at": 1734537278
}

You can update an existing external page (if it was created via the API).

The unique identifier for the external page which is given by Intercom.

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

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

The title of the external page.

Example: "Getting started with..."

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Example: "https://help.example.com/en/articles/1234-getting-started"

Whether the external page should be used to answer questions by Fin.

Default true

Example: true

Default "en"

Value"en"

Example: "en"

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

curl -i -X PUT \
  'https://api.intercom.io/ai/external_pages/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "external_id": "5678",
    "html": "<html><body><h1>Test</h1></body></html>",
    "locale": "en",
    "source_id": 47,
    "title": "Test",
    "url": "https://www.example.com"
  }'

Always external_page

Default "external_page"

Value"external_page"

Example: "external_page"

The unique identifier for the external page which is given by Intercom.

Example: "1234"

The title of the external page.

Example: "Getting started with..."

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Example: "https://help.example.com/en/articles/1234-getting-started"

Whether the external page should be used to answer questions by AI Agent.

Example: true

Whether the external page should be used to answer questions by AI Copilot.

Example: true

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

Example: true

Default "en"

Value"en"

Example: "en"

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

The time when the external page was created.

Example: 1672928359

The time when the external page was last updated.

Example: 1672928610

The time when the external page was last ingested.

Example: 1672928610

{
  "id": "24",
  "type": "external_page",
  "title": "Test",
  "html": "<html><body><h1>Test</h1></body></html>",
  "url": "https://www.example.com",
  "ai_agent_availability": true,
  "ai_copilot_availability": true,
  "fin_availability": true,
  "locale": "en",
  "source_id": 47,
  "external_id": "5678",
  "created_at": 1734537280,
  "updated_at": 1734537281,
  "last_ingested_at": 1734537281
}

Everything about your Articles

Everything about your Away Status Reasons

Everything about your Companies

Everything about your Conversations

With the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

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.

Everything about your Data Attributes

Everything about your Data Events

Everything about your Data Exports

Everything about your Help Center

Everything about your Internal Articles

Everything about your messages

Everything about your News

Everything about your Notes

Everything about Reporting Data Export

Everything about your Segments

Everything about subscription types

Everything about your Teams

Everything about your ticket states

Everything about your ticket type attributes

Everything about your ticket types

Everything about your tickets

Everything about your Visitors

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4