Skip to content

Commit 90fd0f7

Browse files
Help center OpenAPI update (#300)
* Add url_prefix and custom_domain fields to Help Center schema Add two new fields to the help_center schema across all API versions: - url_prefix: The URL path prefix for the help center (e.g., "/help") - custom_domain: Custom domain configured for the help center (nullable) These fields are added to all API versions (0, 2.7-2.14) as Help Center endpoints are not version-gated, making these fields available across all versions. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Fix Help Center URL examples in API documentation Updated url_prefix and custom_domain examples to use correct format: - url_prefix: "https://intercom.help/mycompany" (was "/help") - custom_domain: "help.mycompany.com" (was "help.company.com") 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent 2ca81db commit 90fd0f7

File tree

9 files changed

+81
-0
lines changed

9 files changed

+81
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20387,6 +20387,15 @@ components:
2038720387
type: string
2038820388
description: The display name of the Help Center only seen by teammates.
2038920389
example: Intercom Help Center
20390+
url_prefix:
20391+
type: string
20392+
description: The URL path prefix for the help center
20393+
example: "https://intercom.help/mycompany"
20394+
custom_domain:
20395+
type: string
20396+
nullable: true
20397+
description: Custom domain configured for the help center
20398+
example: "help.mycompany.com"
2039020399
help_center_list:
2039120400
title: Help Centers
2039220401
type: object

descriptions/2.10/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14867,6 +14867,15 @@ components:
1486714867
type: string
1486814868
description: The display name of the Help Center only seen by teammates.
1486914869
example: Intercom Help Center
14870+
url_prefix:
14871+
type: string
14872+
description: The URL path prefix for the help center
14873+
example: "https://intercom.help/mycompany"
14874+
custom_domain:
14875+
type: string
14876+
nullable: true
14877+
description: Custom domain configured for the help center
14878+
example: "help.mycompany.com"
1487014879
help_center_list:
1487114880
title: Help Centers
1487214881
type: object

descriptions/2.11/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15884,6 +15884,15 @@ components:
1588415884
type: string
1588515885
description: The display name of the Help Center only seen by teammates.
1588615886
example: Intercom Help Center
15887+
url_prefix:
15888+
type: string
15889+
description: The URL path prefix for the help center
15890+
example: "https://intercom.help/mycompany"
15891+
custom_domain:
15892+
type: string
15893+
nullable: true
15894+
description: Custom domain configured for the help center
15895+
example: "help.mycompany.com"
1588715896
required:
1588815897
- id
1588915898
- workspace_id

descriptions/2.12/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16154,6 +16154,15 @@ components:
1615416154
type: string
1615516155
description: The display name of the Help Center only seen by teammates.
1615616156
example: Intercom Help Center
16157+
url_prefix:
16158+
type: string
16159+
description: The URL path prefix for the help center
16160+
example: "https://intercom.help/mycompany"
16161+
custom_domain:
16162+
type: string
16163+
nullable: true
16164+
description: Custom domain configured for the help center
16165+
example: "help.mycompany.com"
1615716166
help_center_list:
1615816167
title: Help Centers
1615916168
type: object

descriptions/2.13/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17869,6 +17869,15 @@ components:
1786917869
type: string
1787017870
description: The display name of the Help Center only seen by teammates.
1787117871
example: Intercom Help Center
17872+
url_prefix:
17873+
type: string
17874+
description: The URL path prefix for the help center
17875+
example: "https://intercom.help/mycompany"
17876+
custom_domain:
17877+
type: string
17878+
nullable: true
17879+
description: Custom domain configured for the help center
17880+
example: "help.mycompany.com"
1787217881
help_center_list:
1787317882
title: Help Centers
1787417883
type: object

descriptions/2.14/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19359,6 +19359,15 @@ components:
1935919359
type: string
1936019360
description: The display name of the Help Center only seen by teammates.
1936119361
example: Intercom Help Center
19362+
url_prefix:
19363+
type: string
19364+
description: The URL path prefix for the help center
19365+
example: "https://intercom.help/mycompany"
19366+
custom_domain:
19367+
type: string
19368+
nullable: true
19369+
description: Custom domain configured for the help center
19370+
example: "help.mycompany.com"
1936219371
help_center_list:
1936319372
title: Help Centers
1936419373
type: object

descriptions/2.7/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12859,6 +12859,15 @@ components:
1285912859
type: string
1286012860
description: The display name of the Help Center only seen by teammates.
1286112861
example: Intercom Help Center
12862+
url_prefix:
12863+
type: string
12864+
description: The URL path prefix for the help center
12865+
example: "https://intercom.help/mycompany"
12866+
custom_domain:
12867+
type: string
12868+
nullable: true
12869+
description: Custom domain configured for the help center
12870+
example: "help.mycompany.com"
1286212871
help_center_list:
1286312872
title: Help Centers
1286412873
type: object

descriptions/2.8/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12883,6 +12883,15 @@ components:
1288312883
type: string
1288412884
description: The display name of the Help Center only seen by teammates.
1288512885
example: Intercom Help Center
12886+
url_prefix:
12887+
type: string
12888+
description: The URL path prefix for the help center
12889+
example: "https://intercom.help/mycompany"
12890+
custom_domain:
12891+
type: string
12892+
nullable: true
12893+
description: Custom domain configured for the help center
12894+
example: "help.mycompany.com"
1288612895
help_center_list:
1288712896
title: Help Centers
1288812897
type: object

descriptions/2.9/api.intercom.io.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14222,6 +14222,15 @@ components:
1422214222
type: string
1422314223
description: The display name of the Help Center only seen by teammates.
1422414224
example: Intercom Help Center
14225+
url_prefix:
14226+
type: string
14227+
description: The URL path prefix for the help center
14228+
example: "https://intercom.help/mycompany"
14229+
custom_domain:
14230+
type: string
14231+
nullable: true
14232+
description: Custom domain configured for the help center
14233+
example: "help.mycompany.com"
1422514234
help_center_list:
1422614235
title: Help Centers
1422714236
type: object

0 commit comments

Comments
 (0)