> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: Create External Page

> Add or update a web page in the Intercom Fin content library, by external ID. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Add or update a web page in the Intercom Fin content library, by external ID.

> [!NOTE]
>
> Tool ID: `intercom_create_external_page`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_create_external_page',
  {
    "title": "VP of Engineering",
    "html": "example",
    "locale": "en",
    "source_id": 123,
    "external_id": "external_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_create_external_page --input '{
  "title": "VP of Engineering",
  "html": "example",
  "locale": "en",
  "source_id": 123,
  "external_id": "external_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "external_page",
    "id": "id_123",
    "title": "VP of Engineering",
    "html": "example",
    "ai_agent_availability": true,
    "ai_copilot_availability": true,
    "locale": "en",
    "source_id": 123,
    "external_id": "external_123",
    "created_at": 123,
    "updated_at": 123,
    "last_ingested_at": 123
  }
}
```

Use `deepline describe intercom_create_external_page --json` for the latest machine-readable contract.

## Input reference

You can add an External Page to your Fin Content Library.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.title` | `string` | Yes | — | The title of the external page. |
| `payload.html` | `string` | Yes | — | The body of the external page in HTML. |
| `payload.url` | `string` | No | — | 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. |
| `payload.ai_agent_availability` | `boolean` | No | `false` | Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page. |
| `payload.ai_copilot_availability` | `boolean` | No | `false` | Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page. |
| `payload.locale` | `"en"` | Yes | `"en"` | Always en Allowed: `en`. |
| `payload.source_id` | `integer` | Yes | — | 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. |
| `payload.external_id` | `string` | Yes | — | The identifier for the external page which was given by the source. Must be unique for the source. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can add an External Page to your Fin Content Library.",
    "properties": {
      "title": {
        "type": "string",
        "description": "The title of the external page."
      },
      "html": {
        "type": "string",
        "description": "The body of the external page in HTML."
      },
      "url": {
        "type": "string",
        "description": "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."
      },
      "ai_agent_availability": {
        "type": "boolean",
        "description": "Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.",
        "default": false
      },
      "ai_copilot_availability": {
        "type": "boolean",
        "description": "Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.",
        "default": false
      },
      "locale": {
        "type": "string",
        "description": "Always en",
        "default": "en",
        "enum": [
          "en"
        ]
      },
      "source_id": {
        "type": "integer",
        "description": "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."
      },
      "external_id": {
        "type": "string",
        "description": "The identifier for the external page which was given by the source. Must be unique for the source."
      }
    },
    "required": [
      "title",
      "html",
      "locale",
      "source_id",
      "external_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | External pages that you have added to your Fin Content Library. |
| `result.data.type` | `"external_page"` | Yes | `"external_page"` | Always external\_page Allowed: `external_page`. |
| `result.data.id` | `string` | Yes | — | The unique identifier for the external page which is given by Intercom. |
| `result.data.title` | `string` | Yes | — | The title of the external page. |
| `result.data.html` | `string` | Yes | — | The body of the external page in HTML. |
| `result.data.url` | `string` | No | — | The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. |
| `result.data.ai_agent_availability` | `boolean` | Yes | — | Whether the external page should be used to answer questions by AI Agent. |
| `result.data.ai_copilot_availability` | `boolean` | Yes | — | Whether the external page should be used to answer questions by AI Copilot. |
| `result.data.ai_sales_agent_availability` | `boolean` | No | — | Whether the external page should be used to answer questions by AI Sales Agent. |
| `result.data.fin_availability` | `boolean` | No | — | Deprecated. Use ai\_agent\_availability and ai\_copilot\_availability instead. |
| `result.data.locale` | `"en"` | Yes | `"en"` | Always en Allowed: `en`. |
| `result.data.source_id` | `integer` | Yes | — | 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. |
| `result.data.external_id` | `string` | Yes | — | The identifier for the external page which was given by the source. Must be unique for the source. |
| `result.data.created_at` | `integer` | Yes | — | The time when the external page was created. Format: `date-time`. |
| `result.data.updated_at` | `integer` | Yes | — | The time when the external page was last updated. Format: `date-time`. |
| `result.data.last_ingested_at` | `integer` | Yes | — | The time when the external page was last ingested. Format: `date-time`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "External pages that you have added to your Fin Content Library.",
        "properties": {
          "type": {
            "type": "string",
            "description": "Always external_page",
            "default": "external_page",
            "enum": [
              "external_page"
            ]
          },
          "id": {
            "type": "string",
            "description": "The unique identifier for the external page which is given by Intercom."
          },
          "title": {
            "type": "string",
            "description": "The title of the external page."
          },
          "html": {
            "type": "string",
            "description": "The body of the external page in HTML."
          },
          "url": {
            "type": "string",
            "description": "The URL of the external page. This will be used by Fin to link end users to the page it based its answer on."
          },
          "ai_agent_availability": {
            "type": "boolean",
            "description": "Whether the external page should be used to answer questions by AI Agent."
          },
          "ai_copilot_availability": {
            "type": "boolean",
            "description": "Whether the external page should be used to answer questions by AI Copilot."
          },
          "ai_sales_agent_availability": {
            "type": "boolean",
            "description": "Whether the external page should be used to answer questions by AI Sales Agent."
          },
          "fin_availability": {
            "type": "boolean",
            "description": "Deprecated. Use ai_agent_availability and ai_copilot_availability instead."
          },
          "locale": {
            "type": "string",
            "description": "Always en",
            "default": "en",
            "enum": [
              "en"
            ]
          },
          "source_id": {
            "type": "integer",
            "description": "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."
          },
          "external_id": {
            "type": "string",
            "description": "The identifier for the external page which was given by the source. Must be unique for the source."
          },
          "created_at": {
            "type": "integer",
            "description": "The time when the external page was created.",
            "format": "date-time"
          },
          "updated_at": {
            "type": "integer",
            "description": "The time when the external page was last updated.",
            "format": "date-time"
          },
          "last_ingested_at": {
            "type": "integer",
            "description": "The time when the external page was last ingested.",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "type",
          "title",
          "html",
          "ai_agent_availability",
          "ai_copilot_availability",
          "locale",
          "source_id",
          "created_at",
          "updated_at",
          "last_ingested_at",
          "external_id"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.