Get the Custom Domain
helpcenter_get_custom_domainRead the help center's custom domain: the domain, the DNS record the user must add at their DNS provider, and where it stands on the way to live. Poll it while the user sets up DNS: status moves from pending_dns through verifying and issuing_certificate to live, usually within minutes of the record appearing.
Works once the user has claimed the help center, verified their email address and activated a plan; until then it answers capability_locked with the user's next step (helpcenter_get_help_center shows it too).
Read-only.
Args:
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { custom_domain: { domain, status, dns_records: [ { type, name, value } ], certificate, checks, failure, last_checked_at } }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |