Skip to content

Add url_prefix and custom_domain fields to Help Center schema#298

Closed
VedranZoricic wants to merge 3 commits intointercom:mainfrom
VedranZoricic:new-feature-branch
Closed

Add url_prefix and custom_domain fields to Help Center schema#298
VedranZoricic wants to merge 3 commits intointercom:mainfrom
VedranZoricic:new-feature-branch

Conversation

@VedranZoricic
Copy link
Contributor

Summary

  • Added url_prefix field to help_center schema for URL path prefix (e.g., "/help")
  • Added custom_domain field to help_center schema for custom domain configuration (nullable)
  • Updated all API versions (0, 2.7-2.14) since Help Center endpoints are not version-gated

Changes

  • Modified 9 OpenAPI specification files across all supported API versions
  • Added consistent field definitions with proper types and examples

Context

As documented in the implementation notes, Help Center endpoints are NOT version-gated (unlike other Articles API endpoints), meaning these fields will be available across all API versions. This is an additive, non-breaking change.

Test plan

  • Verify OpenAPI spec validates correctly
  • Confirm fields appear in generated documentation
  • Test that existing integrations continue to work (backwards compatible)

🤖 Generated with Claude Code

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 <noreply@anthropic.com>
@VedranZoricic
Copy link
Contributor Author

@claude fix the example for the prefix, it should be like this:

"url_prefix": "https://intercom.help/mycompany",
"custom_domain": help.mycompany.com

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 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants