Intercom: Retrieve Help Center

Get an Intercom Help Center by its ID.

Tool ID: intercom_retrieve_help_center

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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_retrieve_help_center',
  {
    "help_center_id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_retrieve_help_center --input '{
  "help_center_id": 123
}' --json

Example response

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

{
  "data": {
    "id": "id_123",
    "workspace_id": "workspace_123",
    "created_at": 123
  }
}

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

Input reference

You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/ .

Name	Type	Required	Default	Details
`payload.help_center_id`	`integer`	Yes	—	The unique identifier for the collection which is given by Intercom.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Help Centers contain collections
`result.data.id`	`string`	No	—	The unique identifier for the Help Center which is given by Intercom.
`result.data.workspace_id`	`string`	No	—	The id of the workspace which the Help Center belongs to.
`result.data.created_at`	`integer`	No	—	The time when the Help Center was created. Format: `date-time`.
`result.data.updated_at`	`integer`	No	—	The time when the Help Center was last updated. Format: `date-time`.
`result.data.identifier`	`string`	No	—	The identifier of the Help Center. This is used in the URL of the Help Center.
`result.data.website_turned_on`	`boolean`	No	—	Whether the Help Center is turned on or not. This is controlled in your Help Center settings.
`result.data.display_name`	`string`	No	—	The display name of the Help Center only seen by teammates.
`result.data.url`	`string`	No	—	The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.
`result.data.custom_domain`	`string \| null`	No	—	Custom domain configured for the help center
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation