Channel type. messenger is a deprecated alias of facebook; servers emit facebook.
Available options:
whatsapp,
instagram,
facebook,
messenger
workspaceId
string
ws_ publicId
metaResourceId
string
Advanced Meta provider identifier. For WhatsApp this is the WABA ID.
For Instagram this is the Instagram account Graph ID. For Facebook this is
the Page ID. Use id (ch_...) for HookMyApp API calls and friendly fields
for display.
metaPageId
string | null
On an Instagram channel connected through a Facebook Page, the Page ID. Null on WhatsApp channels, on Facebook channels (their Page ID is metaResourceId) and on Instagram channels connected directly.
metaWabaId
string | null
WhatsApp WABA ID, retained for compatibility. Null for non-WhatsApp channels.
updatedAt
string<date-time>
whatsappWabaName
string | null
whatsappDisplayPhoneNumber
string | null
whatsappPhoneNumberId
string | null
whatsappVerifiedName
string | null
whatsappProfilePictureUrl
string | null
Short-lived signed HookMyApp URL for the channel's profile
picture. Fetch it soon after reading the response; mint a fresh
one by re-reading the channel when it expires.
whatsappQualityRating
string | null
instagramUsername
string | null
instagramProfileName
string | null
instagramProfilePictureUrl
string | null
facebookPageName
string | null
facebookPagePictureUrl
string | null
connectionType
string
How the channel was connected: cloud_api or coexistence for WhatsApp, instagram_login for Instagram connected directly, facebook_login for a Facebook Page and the Instagram account linked to it.
metaConnected
boolean
Whether Meta currently appears connected for this channel. This is Meta health, not the HookMyApp lifecycle state.
forwardingEnabled
boolean
forwardingDisabledReason
string | null
channelStatus
enum<string>
HookMyApp lifecycle state. Use this to decide whether the channel is active in HookMyApp.
Available options:
connected,
disconnected,
archived
metaRetryDisabled
boolean
whatsappGroups
object
Whether Meta serves the Groups API on this WhatsApp number. Present on WhatsApp channels only, on the channel detail read. Informs only; calls are never blocked by it.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"HookMyApp","colors":{"primary":"#0064E0","light":"#4D94FF","dark":"#0064E0"},"logo":{"light":"https://mintcdn.com/hookmyapp/r2iL9x_c5qM0UPTB/logo/light.svg?fit=max\u0026auto=format\u0026n=r2iL9x_c5qM0UPTB\u0026q=85\u0026s=b6813b399dafa520bb08e249c21b31cb","dark":"https://mintcdn.com/hookmyapp/r2iL9x_c5qM0UPTB/logo/dark.svg?fit=max\u0026auto=format\u0026n=r2iL9x_c5qM0UPTB\u0026q=85\u0026s=7ebeb48021019cae7f2bcb1b2b150b5b","href":"https://hookmyapp.com"},"favicon":"https://mintcdn.com/hookmyapp/tzMzNQ4twk4FWftS/favicon.svg?fit=max\u0026auto=format\u0026n=tzMzNQ4twk4FWftS\u0026q=85\u0026s=5f8acae4a19669d1de6f932e0be05256","appearance":{"default":"dark","strict":true},"background":{"color":{"dark":"#000000"}},"navbar":{"links":[{"href":"mailto:support@hookmyapp.com","label":"Support"}],"primary":{"type":"button","label":"App","href":"https://app.hookmyapp.com"}},"footer":{"socials":{"github":"https://github.com/hookmyapp"}},"seo":{"indexing":"navigable"},"fonts":{"family":"Montserrat"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/orgs/hookmyapp/repositories"},{"anchor":"Agent Skills","icon":"sparkles","href":"https://github.com/hookmyapp/agent-skills"},{"anchor":"npm","icon":"npm","href":"https://www.npmjs.com/package/@gethookmyapp/cli"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hookmyapp","hasAudioNarration":false,"actualSubdomain":"hookmyapp","customDomains":["docs.hookmyapp.com"],"gitSource":{"type":"github","owner":"hookmyapp","repo":"mintlify-docs","deployBranch":"production","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b0185ddf7c8d7c59292e9df","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":138},{"language":"default","tag":"WhatsApp","count":85},{"language":"default","tag":"Instagram","count":70},{"language":"default","tag":"Sending \u0026 receiving","count":56},{"language":"default","tag":"Facebook","count":44},{"language":"default","tag":"SaaS Mode","count":42},{"language":"default","tag":"Send messages","count":24},{"language":"default","tag":"Webhooks","count":18},{"language":"default","tag":"Groups","count":18},{"language":"default","tag":"Getting started","count":15}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"html.dark,.dark body{background-color:#000000}.dark .card{background-color:#1c1e21}*{scrollbar-width:none;-ms-overflow-style:none}*::-webkit-scrollbar{display:none;width:0;height:0}#sidebar-content{display:flex;flex-direction:column;overflow:hidden}#navigation-items{flex:1 1 auto;min-height:0;overflow-y:auto}#navigation-items>ul.list-none:first-child{position:sticky;top:0;z-index:10;margin-top:0;padding-top:1.5rem;padding-bottom:0.25rem;background:#ffffff}.dark #navigation-items>ul.list-none:first-child{background:#000000}#navigation-items>div:first-of-type{margin-top:0.25rem}.agent-prompt-copy{display:inline-flex;align-items:center;gap:0.5rem;padding:0.65rem 1.4rem;border:none;border-radius:100px;font-size:0.9375rem;font-weight:600;cursor:pointer;background-color:#0064e0;color:#ffffff;transition:background-color 120ms ease, transform 120ms ease}.agent-prompt-copy:hover{background-color:#0053ba}.agent-prompt-copy:active{transform:scale(0.98)}#sidebar a[href=\"/setup\"],#navigation-items a[href=\"/setup\"]{display:none}"}]}
{"page":{"pagePath":"saas-mode/api/customer-channels/get-channel","slug":"/saas-mode/api/customer-channels/get-channel","pageMetadata":{"openapi":"api-reference/openapi.yaml GET /meta/channels/{id}","title":"Get channel","description":null,"href":"/saas-mode/api/customer-channels/get-channel"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"api-reference/openapi.yaml GET /meta/channels/{id}","title":"Get channel","description":null,"href":"/saas-mode/api/customer-channels/get-channel"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/hookmyapp/97aaa793991b457a/agent-prompt-copy.js","/_mintlify/custom/hookmyapp/89b5470ba7369309/no-translate-code.js"],"openApiReferenceData":{"operation":{"tags":["Channels"],"summary":"Get channel","operationId":"getChannel","parameters":["243543f4-ca39-4ad5-a0b5-da16dc0396aa"],"responses":{"200":"e4815b54-8c0c-46a2-8165-80379aab7c4e","404":"fcbecc46-8e75-4d29-9e34-c04713d90ee4"},"method":"get","type":"path","servers":["21684db9-ac8b-498b-a811-55c5026d4c76"],"security":["3d3207c7-6be4-4dac-891b-15bc8fab1236"],"path":"/meta/channels/{id}","baseUrlOptions":["https://api.hookmyapp.com"],"title":"Get channel","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"243543f4-ca39-4ad5-a0b5-da16dc0396aa":{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ch_[A-Za-z0-9]{8}$","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"e4815b54-8c0c-46a2-8165-80379aab7c4e":{"description":"Channel detail (adds `metaBusinessId`, `whatsappBusinessName`)","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ch_ publicId","uniqueKey":"id","typeLabel":"string"},"type":{"type":"string","enum":["whatsapp","instagram","facebook","messenger"],"description":"Channel type. `messenger` is a deprecated alias of `facebook`; servers emit `facebook`.","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"workspaceId":{"type":"string","description":"ws_ publicId","uniqueKey":"workspaceId","typeLabel":"string"},"metaResourceId":{"type":"string","description":"Advanced Meta provider identifier. For WhatsApp this is the WABA ID.\nFor Instagram this is the Instagram account Graph ID. For Facebook this is\nthe Page ID. Use `id` (`ch_...`) for HookMyApp API calls and friendly fields\nfor display.\n","uniqueKey":"metaResourceId","typeLabel":"string"},"metaPageId":{"oneOf":[{"type":"string","description":"On an Instagram channel connected through a Facebook Page, the Page ID. Null on WhatsApp channels, on Facebook channels (their Page ID is `metaResourceId`) and on Instagram channels connected directly.","uniqueKey":"metaPageId.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an Instagram channel connected through a Facebook Page, the Page ID. Null on WhatsApp channels, on Facebook channels (their Page ID is `metaResourceId`) and on Instagram channels connected directly.","uniqueKey":"metaPageId.oneOf.1","typeLabel":"null"}],"uniqueKey":"metaPageId","typeLabel":"string | null"},"metaWabaId":{"oneOf":[{"type":"string","description":"WhatsApp WABA ID, retained for compatibility. Null for non-WhatsApp channels.","uniqueKey":"metaWabaId.oneOf.0","typeLabel":"string"},{"type":"null","description":"WhatsApp WABA ID, retained for compatibility. Null for non-WhatsApp channels.","uniqueKey":"metaWabaId.oneOf.1","typeLabel":"null"}],"uniqueKey":"metaWabaId","typeLabel":"string | null"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"whatsappWabaName":{"oneOf":[{"type":"string","uniqueKey":"whatsappWabaName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"whatsappWabaName.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsappWabaName","typeLabel":"string | null"},"whatsappDisplayPhoneNumber":{"oneOf":[{"type":"string","uniqueKey":"whatsappDisplayPhoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"whatsappDisplayPhoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsappDisplayPhoneNumber","typeLabel":"string | null"},"whatsappPhoneNumberId":{"oneOf":[{"type":"string","uniqueKey":"whatsappPhoneNumberId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"whatsappPhoneNumberId.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsappPhoneNumberId","typeLabel":"string | null"},"whatsappVerifiedName":{"oneOf":[{"type":"string","uniqueKey":"whatsappVerifiedName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"whatsappVerifiedName.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsappVerifiedName","typeLabel":"string | null"},"whatsappProfilePictureUrl":{"oneOf":[{"type":"string","description":"Short-lived signed HookMyApp URL for the channel's profile\npicture. Fetch it soon after reading the response; mint a fresh\none by re-reading the channel when it expires.\n","uniqueKey":"whatsappProfilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Short-lived signed HookMyApp URL for the channel's profile\npicture. Fetch it soon after reading the response; mint a fresh\none by re-reading the channel when it expires.\n","uniqueKey":"whatsappProfilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsappProfilePictureUrl","typeLabel":"string | null"},"whatsappQualityRating":{"oneOf":[{"type":"string","uniqueKey":"whatsappQualityRating.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"whatsappQualityRating.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsappQualityRating","typeLabel":"string | null"},"instagramUsername":{"oneOf":[{"type":"string","uniqueKey":"instagramUsername.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instagramUsername.oneOf.1","typeLabel":"null"}],"uniqueKey":"instagramUsername","typeLabel":"string | null"},"instagramProfileName":{"oneOf":[{"type":"string","uniqueKey":"instagramProfileName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instagramProfileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instagramProfileName","typeLabel":"string | null"},"instagramProfilePictureUrl":{"oneOf":[{"type":"string","uniqueKey":"instagramProfilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instagramProfilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"instagramProfilePictureUrl","typeLabel":"string | null"},"facebookPageName":{"oneOf":[{"type":"string","uniqueKey":"facebookPageName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"facebookPageName.oneOf.1","typeLabel":"null"}],"uniqueKey":"facebookPageName","typeLabel":"string | null"},"facebookPagePictureUrl":{"oneOf":[{"type":"string","uniqueKey":"facebookPagePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"facebookPagePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"facebookPagePictureUrl","typeLabel":"string | null"},"connectionType":{"type":"string","description":"How the channel was connected: `cloud_api` or `coexistence` for WhatsApp, `instagram_login` for Instagram connected directly, `facebook_login` for a Facebook Page and the Instagram account linked to it.","uniqueKey":"connectionType","typeLabel":"string"},"metaConnected":{"type":"boolean","description":"Whether Meta currently appears connected for this channel. This is Meta health, not the HookMyApp lifecycle state.","uniqueKey":"metaConnected","typeLabel":"boolean"},"forwardingEnabled":{"type":"boolean","uniqueKey":"forwardingEnabled","typeLabel":"boolean"},"forwardingDisabledReason":{"oneOf":[{"type":"string","uniqueKey":"forwardingDisabledReason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"forwardingDisabledReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"forwardingDisabledReason","typeLabel":"string | null"},"channelStatus":{"type":"string","enum":["connected","disconnected","archived"],"description":"HookMyApp lifecycle state. Use this to decide whether the channel is active in HookMyApp.","uniqueKey":"channelStatus","typeLabel":"enum\u003cstring>"},"metaRetryDisabled":{"type":"boolean","uniqueKey":"metaRetryDisabled","typeLabel":"boolean"},"whatsappGroups":{"type":"object","description":"Whether Meta serves the Groups API on this WhatsApp number. Present on WhatsApp channels only, on the channel detail read. Informs only; calls are never blocked by it.","required":["available","reason"],"additionalProperties":false,"properties":{"available":{"type":"boolean","isRequired":true,"uniqueKey":"whatsappGroups.available","typeLabel":"boolean"},"reason":{"oneOf":[{"type":"string","enum":["whatsapp_business_app_number","not_on_cloud_api","not_official_business_account","unknown",null],"description":"Why Groups is unavailable. `unknown` means the number's Official Business Account status has not been read yet. Null when available.","isRequired":true,"uniqueKey":"whatsappGroups.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["whatsapp_business_app_number","not_on_cloud_api","not_official_business_account","unknown",null],"description":"Why Groups is unavailable. `unknown` means the number's Official Business Account status has not been read yet. Null when available.","isRequired":true,"uniqueKey":"whatsappGroups.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"whatsappGroups.reason","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"whatsappGroups","typeLabel":"object"},"credentialPublicId":{"oneOf":[{"type":"string","description":"cred_ publicId","uniqueKey":"credentialPublicId.oneOf.0","typeLabel":"string"},{"type":"null","description":"cred_ publicId","uniqueKey":"credentialPublicId.oneOf.1","typeLabel":"null"}],"uniqueKey":"credentialPublicId","typeLabel":"string | null"},"webhookUrl":{"oneOf":[{"type":"string","uniqueKey":"webhookUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"webhookUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhookUrl","typeLabel":"string | null"},"verifyToken":{"oneOf":[{"type":"string","uniqueKey":"verifyToken.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"verifyToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"verifyToken","typeLabel":"string | null"},"hmacSecret":{"oneOf":[{"type":"string","uniqueKey":"hmacSecret.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"hmacSecret.oneOf.1","typeLabel":"null"}],"uniqueKey":"hmacSecret","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","type":"whatsapp","workspaceId":"\u003cstring>","metaResourceId":"\u003cstring>","metaPageId":"\u003cstring>","metaWabaId":"\u003cstring>","updatedAt":"2023-11-07T05:31:56Z","whatsappWabaName":"\u003cstring>","whatsappDisplayPhoneNumber":"\u003cstring>","whatsappPhoneNumberId":"\u003cstring>","whatsappVerifiedName":"\u003cstring>","whatsappProfilePictureUrl":"\u003cstring>","whatsappQualityRating":"\u003cstring>","instagramUsername":"\u003cstring>","instagramProfileName":"\u003cstring>","instagramProfilePictureUrl":"\u003cstring>","facebookPageName":"\u003cstring>","facebookPagePictureUrl":"\u003cstring>","connectionType":"\u003cstring>","metaConnected":true,"forwardingEnabled":true,"forwardingDisabledReason":"\u003cstring>","channelStatus":"connected","metaRetryDisabled":true,"whatsappGroups":{"available":true,"reason":"whatsapp_business_app_number"},"credentialPublicId":"\u003cstring>","webhookUrl":"\u003cstring>","verifyToken":"\u003cstring>","hmacSecret":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fcbecc46-8e75-4d29-9e34-c04713d90ee4":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code","mirrors the response status":null,"uniqueKey":"statusCode","typeLabel":"integer"},"code":{"type":"string","description":"Stable machine-readable code, e.g. `AGENT_SCOPE_INSUFFICIENT`","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Include this when contacting support about the request","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"code":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3d3207c7-6be4-4dac-891b-15bc8fab1236":{"bearerAuth":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer hmok_...` API key or a dashboard session token","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"21684db9-ac8b-498b-a811-55c5026d4c76":{"url":"https://api.hookmyapp.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer hmok_...` API key or a dashboard session token","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"`Authorization: Bearer hmok_...` API key or a dashboard session token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"hookmyapp","siteName":"HookMyApp","title":"Get channel - HookMyApp","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T08:14:41.397Z","originalFileLocation":"saas-mode/api/customer-channels/get-channel.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"HookMyApp\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get channel - HookMyApp\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HookMyApp\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hookmyapp.mintlify.site/_mintlify/api/og/v2?division=Customer+channels\u0026amp;title=Get+channel\u0026amp;theme=1ad643f1ca59ab81293104be\u0026amp;signature=bbaf7a42797cf419d149f5d484082cd50dd69c15ac94c5ba9153955b8a08dfec\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get channel - HookMyApp\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hookmyapp.mintlify.site/_mintlify/api/og/v2?division=Customer+channels\u0026amp;title=Get+channel\u0026amp;theme=1ad643f1ca59ab81293104be\u0026amp;signature=bbaf7a42797cf419d149f5d484082cd50dd69c15ac94c5ba9153955b8a08dfec\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hookmyapp/Q_hySUa2jMCAKc21/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HookMyApp\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0064E0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/saas-mode/api/customer-channels/get-channel.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hookmyapp.com/#organization\",\"name\":\"HookMyApp\",\"url\":\"https://docs.hookmyapp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hookmyapp/r2iL9x_c5qM0UPTB/logo/light.svg?fit=max\u0026auto=format\u0026n=r2iL9x_c5qM0UPTB\u0026q=85\u0026s=b6813b399dafa520bb08e249c21b31cb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hookmyapp.com#website\",\"name\":\"HookMyApp\",\"url\":\"https://docs.hookmyapp.com\",\"publisher\":{\"@id\":\"https://docs.hookmyapp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel#webpage\",\"url\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel\",\"name\":\"Get channel\",\"dateModified\":\"2026-11-07T08:14:41.397Z\",\"isPartOf\":{\"@id\":\"https://docs.hookmyapp.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.hookmyapp.com/saas-mode/api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer channels\",\"item\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/list-channels-in-a-workspace\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get channel\",\"item\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel#apireference\",\"headline\":\"Get channel\",\"name\":\"Get channel\",\"url\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hookmyapp.com/saas-mode/api/customer-channels/get-channel#webpage\"},\"dateModified\":\"2026-11-07T08:14:41.397Z\",\"publisher\":{\"@id\":\"https://docs.hookmyapp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hookmyapp.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HookMyApp\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"HookMyApp\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/saas-mode/api/customer-channels/get-channel.md","siteName":"HookMyApp","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/orgs/hookmyapp/repositories"},{"anchor":"Agent Skills","icon":"sparkles","href":"https://github.com/hookmyapp/agent-skills"},{"anchor":"npm","icon":"npm","href":"https://www.npmjs.com/package/@gethookmyapp/cli"}]},"tabs":[{"tab":"WhatsApp","pages":[{"title":"WhatsApp","href":""}]},{"tab":"Instagram","pages":[{"title":"Instagram","href":"/instagram"}]},{"tab":"Facebook","pages":[{"title":"Facebook","href":"/facebook"}]},{"tab":"SaaS Mode","groups":[{"group":"Customer Messaging","pages":[{"title":"SaaS Mode","href":"/saas-mode/overview"},{"title":"Customers","href":"/saas-mode/customers"},{"title":"Onboarding links","href":"/saas-mode/onboarding-links"},{"title":"Connection events","href":"/saas-mode/connection-events"},{"title":"Event subscriptions","href":"/saas-mode/event-subscriptions"},{"title":"CLI","href":"/saas-mode/cli"},{"title":"MCP","href":"/saas-mode/mcp-server"}]},{"group":"API Reference","pages":[{"title":"API overview","href":"/saas-mode/api/overview"},{"group":"Messages","pages":[{"title":"Send a message","href":"/saas-mode/api/messages/send-message"},{"openapi":"api-reference/openapi.yaml POST /channels/{ch}/messages","title":"Send a message (API key)","href":"/saas-mode/api/messages/send-message-api-key"},{"title":"Send a WhatsApp message","api":"POST https://gateway.hookmyapp.com/meta/v22.0/{PHONE_NUMBER_ID}/messages","href":"/saas-mode/api/messages/send-whatsapp-message"},{"title":"Send an Instagram message","api":"POST https://gateway.hookmyapp.com/meta/v25.0/{INSTAGRAM_ACCOUNT_ID}/messages","href":"/saas-mode/api/messages/send-instagram-message"}]},{"group":"Customers","pages":[{"openapi":"api-reference/openapi.yaml GET /organizations/{orgId}/workspaces","title":"List organization workspaces","href":"/saas-mode/api/customers/list-organization-workspaces"},{"openapi":"api-reference/openapi.yaml POST /organizations/{orgId}/customers","title":"Create customer","href":"/saas-mode/api/customers/create-customer"}]},{"group":"Onboarding links","pages":[{"openapi":"api-reference/openapi.yaml POST /org/onboarding-links","title":"Create onboarding link","href":"/saas-mode/api/onboarding-links/create-onboarding-link"},{"openapi":"api-reference/openapi.yaml GET /org/onboarding-links","title":"List onboarding links","href":"/saas-mode/api/onboarding-links/list-onboarding-links"},{"openapi":"api-reference/openapi.yaml PATCH /org/onboarding-links/{publicId}","title":"Update onboarding link","href":"/saas-mode/api/onboarding-links/update-onboarding-link"},{"openapi":"api-reference/openapi.yaml DELETE /org/onboarding-links/{publicId}","title":"Deactivate onboarding link","href":"/saas-mode/api/onboarding-links/deactivate-onboarding-link"},{"openapi":"api-reference/openapi.yaml POST /org/onboarding-links/{publicId}/regenerate","title":"Regenerate onboarding link URL","href":"/saas-mode/api/onboarding-links/regenerate-onboarding-link-url"}]},{"group":"Customer channels","pages":[{"openapi":"api-reference/openapi.yaml GET /meta/channels","title":"List channels in a workspace","description":"Returns every channel in the selected workspace, whatever its `type`: WhatsApp,\nInstagram and Facebook channels come back in one list. Use `id` (`ch_...`) for\nHookMyApp API calls and `type` to branch. The provider-specific fields of the\nother providers are `null`: use `whatsappDisplayPhoneNumber`, `instagramUsername`\nor `facebookPageName` for customer-facing labels. A Page and the Instagram\naccount linked to it are two channels; the Instagram one carries the Page in\n`metaPageId`.\n","href":"/saas-mode/api/customer-channels/list-channels-in-a-workspace"},{"openapi":"api-reference/openapi.yaml GET /meta/channels/{id}","title":"Get channel","href":"/saas-mode/api/customer-channels/get-channel"},{"openapi":"api-reference/openapi.yaml GET /meta/channels/{id}/token","title":"Get channel token","description":"Returns the `hmat_` token used to send messages, reply to comments, and\npublish from this channel.\n","href":"/saas-mode/api/customer-channels/get-channel-token"},{"openapi":"api-reference/openapi.yaml POST /meta/channels/{id}/token/rotate","title":"Rotate channel token","href":"/saas-mode/api/customer-channels/rotate-channel-token"},{"openapi":"api-reference/openapi.yaml GET /meta/channels/{id}/env","title":"Get channel environment variables","href":"/saas-mode/api/customer-channels/get-channel-environment-variables"},{"openapi":"api-reference/openapi.yaml POST /channels/{publicId}/move","title":"Move channel","href":"/saas-mode/api/customer-channels/move-channel"}]},{"group":"Customer channel webhooks","pages":[{"openapi":"api-reference/openapi.yaml GET /webhook-config/{channelId}","title":"Get webhook destination","href":"/saas-mode/api/customer-channel-webhooks/get-webhook-destination"},{"openapi":"api-reference/openapi.yaml PUT /webhook-config/{channelId}","title":"Update webhook destination","href":"/saas-mode/api/customer-channel-webhooks/update-webhook-destination"},{"openapi":"api-reference/openapi.yaml DELETE /webhook-config/{channelId}","title":"Clear webhook destination","href":"/saas-mode/api/customer-channel-webhooks/clear-webhook-destination"},{"openapi":"api-reference/openapi.yaml POST /webhook-config","title":"Create webhook destination","href":"/saas-mode/api/customer-channel-webhooks/create-webhook-destination"},{"openapi":"api-reference/openapi.yaml GET /webhook-config/{channelId}/hmac","title":"Get webhook signing secret","href":"/saas-mode/api/customer-channel-webhooks/get-webhook-signing-secret"},{"openapi":"api-reference/openapi.yaml POST /webhook-config/{channelId}/rotate-hmac","title":"Rotate webhook signing secret","href":"/saas-mode/api/customer-channel-webhooks/rotate-webhook-signing-secret"}]},{"group":"Customer channel delivery logs","pages":[{"openapi":"api-reference/openapi.yaml GET /deliveries","title":"List delivery logs","href":"/saas-mode/api/customer-channel-delivery-logs/list-delivery-logs"},{"openapi":"api-reference/openapi.yaml GET /deliveries/{publicId}","title":"Get a delivery log","href":"/saas-mode/api/customer-channel-delivery-logs/get-a-delivery-log"}]},{"group":"Agent auth","pages":[{"openapi":"api-reference/openapi.yaml POST /agent/auth/claim","title":"Start email-OTP registration","href":"/saas-mode/api/agent-auth/start-email-otp-registration"},{"openapi":"api-reference/openapi.yaml POST /agent/auth/claim/complete","title":"Exchange OTP for agent credential","href":"/saas-mode/api/agent-auth/exchange-otp-for-agent-credential"},{"openapi":"api-reference/openapi.yaml POST /agent/auth","title":"Register (single-call variants)","href":"/saas-mode/api/agent-auth/register-single-call-variants"},{"openapi":"api-reference/openapi.yaml GET /agent/credentials","title":"List agent credentials","href":"/saas-mode/api/agent-auth/list-agent-credentials"},{"openapi":"api-reference/openapi.yaml DELETE /agent/credentials/{publicId}","title":"Revoke agent credential","href":"/saas-mode/api/agent-auth/revoke-agent-credential"}]},{"group":"Support","pages":[{"openapi":"api-reference/openapi.yaml POST /support/tickets","title":"Open a support ticket","href":"/saas-mode/api/support/open-support-ticket"},{"openapi":"api-reference/openapi.yaml GET /support/tickets","title":"List support tickets","href":"/saas-mode/api/support/list-support-tickets"},{"openapi":"api-reference/openapi.yaml GET /support/tickets/{id}","title":"Read a support ticket","href":"/saas-mode/api/support/get-support-ticket"},{"openapi":"api-reference/openapi.yaml POST /support/tickets/{id}/messages","title":"Reply on a support ticket","href":"/saas-mode/api/support/reply-support-ticket"}]}]}]}]},"basePath":"","title":"Get channel - HookMyApp","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}