Skip to content
Home/
REST API Reference
/
/
API Template Source

API Template Source

A source that imports content from a knowledge base's REST API using a template. The source's auth_token is never returned.

typestringrequired

Always api_template_source.

Value:"api_template_source"
Example:"api_template_source"
idstringrequired

The unique identifier for the source, given by Intercom.

Example:"4182"
templateobject(API Template)required

The source's template, as saved. Top-level keys that aren't template fields are removed.

Example:
{
  "name": "Example Docs",
  "base_url": "https://api.example.com/v1",
  "variables": [
    "space_id"
  ],
  "auth": {
    "header": "Authorization",
    "value": "Bearer {token}"
  },
  "tree": {
    "path": "/spaces/{space_id}/pages",
    "query": { … },
    "nodes": [ … ],
    "children": "pages",
    "folder_if": [ … ],
    "folder_if_has_children": true,
    "content_if": [ … ]
  },
  "item": {
    "path": "/spaces/{space_id}/pages/{page_id}",
    "node_values": { … }
  },
  "mapping": {
    "id": [ … ],
    "title": [ … ],
    "body": [ … ],
    "updated_at": [ … ]
  },
  "body_format": "html"
}
variablesobjectrequired

The values of the template's variables, as strings. Values for names the template doesn't declare are removed.

Example:
{
  "space_id": "help-center"
}
created_atinteger, (date-time)required

The time the source was created.

Example:1792713600
latest_syncobject or nullrequired

The source's most recent sync, or null if no sync has started.

Example:
{
  "id": "90817",
  "status": "in_progress",
  "created_at": 1792713601,
  "updated_at": 1792713601
}
{
  "type": "api_template_source",
  "id": "4182",
  "template": {
    "name": "Example Docs",
    "base_url": "https://api.example.com/v1",
    "variables": [ … ],
    "auth": { … },
    "tree": { … },
    "item": { … },
    "mapping": { … },
    "body_format": "html"
  },
  "variables": {
    "space_id": "help-center"
  },
  "created_at": 1792713600,
  "latest_sync": {
    "id": "90817",
    "status": "in_progress",
    "created_at": 1792713601,
    "updated_at": 1792713601
  }
}