Channels

List channels in a workspace

Returns every channel in the selected workspace, whatever its type: WhatsApp, Instagram and Facebook channels come back in one list. Use id (ch_...) for HookMyApp API calls and type to branch. The provider-specific fields of the other providers are null: use whatsappDisplayPhoneNumber, instagramUsername or facebookPageName for customer-facing labels. A Page and the Instagram account linked to it are two channels; the Instagram one carries the Page in metaPageId.

GET

meta

channels

curl --request GET \
  --url https://api.hookmyapp.com/meta/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Workspace-Id: <x-workspace-id>'

import requests

url = "https://api.hookmyapp.com/meta/channels"

headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Workspace-Id': '<x-workspace-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.hookmyapp.com/meta/channels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hookmyapp.com/meta/channels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hookmyapp.com/meta/channels"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hookmyapp.com/meta/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "ch_CRNMuHnE",
    "type": "facebook",
    "workspaceId": "ws_iCQbMfZp",
    "metaResourceId": "675007665699897",
    "metaPageId": null,
    "metaWabaId": null,
    "updatedAt": "2026-09-19T06:39:12Z",
    "whatsappWabaName": null,
    "whatsappDisplayPhoneNumber": null,
    "whatsappPhoneNumberId": null,
    "whatsappVerifiedName": null,
    "whatsappProfilePictureUrl": null,
    "whatsappQualityRating": null,
    "instagramUsername": null,
    "instagramProfileName": null,
    "instagramProfilePictureUrl": null,
    "facebookPageName": "7-Day Replay or Buy System",
    "facebookPagePictureUrl": "https://api.hookmyapp.com/meta/channels/ch_CRNMuHnE/picture?sig=...",
    "connectionType": "facebook_login",
    "metaConnected": true,
    "forwardingEnabled": true,
    "forwardingDisabledReason": null,
    "channelStatus": "connected",
    "metaRetryDisabled": false,
    "credentialPublicId": "cred_9fA2kLm1",
    "webhookUrl": "https://example.com/webhook/facebook",
    "verifyToken": null,
    "hmacSecret": null
  },
  {
    "id": "ch_44yKfOlC",
    "type": "instagram",
    "workspaceId": "ws_iCQbMfZp",
    "metaResourceId": "17841475496208061",
    "metaPageId": "675007665699897",
    "metaWabaId": null,
    "updatedAt": "2026-09-19T06:39:12Z",
    "whatsappWabaName": null,
    "whatsappDisplayPhoneNumber": null,
    "whatsappPhoneNumberId": null,
    "whatsappVerifiedName": null,
    "whatsappProfilePictureUrl": null,
    "whatsappQualityRating": null,
    "instagramUsername": "7_day_replay_or_buy_system",
    "instagramProfileName": "Or Dvir",
    "instagramProfilePictureUrl": "https://api.hookmyapp.com/meta/channels/ch_44yKfOlC/picture?sig=...",
    "facebookPageName": null,
    "facebookPagePictureUrl": null,
    "connectionType": "facebook_login",
    "metaConnected": true,
    "forwardingEnabled": true,
    "forwardingDisabledReason": null,
    "channelStatus": "connected",
    "metaRetryDisabled": false,
    "credentialPublicId": "cred_9fA2kLm1",
    "webhookUrl": "https://example.com/webhook/facebook",
    "verifyToken": null,
    "hmacSecret": null
  }
]

Authorizations

Authorization

string

header

required

Authorization: Bearer hmok_... API key or a dashboard session token

Headers

X-Workspace-Id

string

required

Workspace ID for the request

Pattern: ^ws_[A-Za-z0-9]{8}$

Response

200 - application/json

Channels in the workspace

string

ch_ publicId

type

enum<string>

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

credentialPublicId

string | null

cred_ publicId

webhookUrl

string | null

verifyToken

string | null

hmacSecret

string | null

List channels in a workspace

curl --request GET \
  --url https://api.hookmyapp.com/meta/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Workspace-Id: <x-workspace-id>'

import requests

url = "https://api.hookmyapp.com/meta/channels"

headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Workspace-Id': '<x-workspace-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.hookmyapp.com/meta/channels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hookmyapp.com/meta/channels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hookmyapp.com/meta/channels"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hookmyapp.com/meta/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "ch_CRNMuHnE",
    "type": "facebook",
    "workspaceId": "ws_iCQbMfZp",
    "metaResourceId": "675007665699897",
    "metaPageId": null,
    "metaWabaId": null,
    "updatedAt": "2026-09-19T06:39:12Z",
    "whatsappWabaName": null,
    "whatsappDisplayPhoneNumber": null,
    "whatsappPhoneNumberId": null,
    "whatsappVerifiedName": null,
    "whatsappProfilePictureUrl": null,
    "whatsappQualityRating": null,
    "instagramUsername": null,
    "instagramProfileName": null,
    "instagramProfilePictureUrl": null,
    "facebookPageName": "7-Day Replay or Buy System",
    "facebookPagePictureUrl": "https://api.hookmyapp.com/meta/channels/ch_CRNMuHnE/picture?sig=...",
    "connectionType": "facebook_login",
    "metaConnected": true,
    "forwardingEnabled": true,
    "forwardingDisabledReason": null,
    "channelStatus": "connected",
    "metaRetryDisabled": false,
    "credentialPublicId": "cred_9fA2kLm1",
    "webhookUrl": "https://example.com/webhook/facebook",
    "verifyToken": null,
    "hmacSecret": null
  },
  {
    "id": "ch_44yKfOlC",
    "type": "instagram",
    "workspaceId": "ws_iCQbMfZp",
    "metaResourceId": "17841475496208061",
    "metaPageId": "675007665699897",
    "metaWabaId": null,
    "updatedAt": "2026-09-19T06:39:12Z",
    "whatsappWabaName": null,
    "whatsappDisplayPhoneNumber": null,
    "whatsappPhoneNumberId": null,
    "whatsappVerifiedName": null,
    "whatsappProfilePictureUrl": null,
    "whatsappQualityRating": null,
    "instagramUsername": "7_day_replay_or_buy_system",
    "instagramProfileName": "Or Dvir",
    "instagramProfilePictureUrl": "https://api.hookmyapp.com/meta/channels/ch_44yKfOlC/picture?sig=...",
    "facebookPageName": null,
    "facebookPagePictureUrl": null,
    "connectionType": "facebook_login",
    "metaConnected": true,
    "forwardingEnabled": true,
    "forwardingDisabledReason": null,
    "channelStatus": "connected",
    "metaRetryDisabled": false,
    "credentialPublicId": "cred_9fA2kLm1",
    "webhookUrl": "https://example.com/webhook/facebook",
    "verifyToken": null,
    "hmacSecret": null
  }
]

Getting started

Sending & receiving

Publish & engage

Tools

API Reference

List channels in a workspace

Authorizations

Headers

Response