Get channel

GET

meta

channels

{id}

Get channel

curl --request GET \
  --url https://api.hookmyapp.com/meta/channels/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hookmyapp.com/meta/channels/{id}', 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/{id}",
  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>"
  ],
]);

$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/{id}"

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

	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/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "workspaceId": "<string>",
  "metaResourceId": "<string>",
  "metaWabaId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "whatsappWabaName": "<string>",
  "whatsappDisplayPhoneNumber": "<string>",
  "whatsappPhoneNumberId": "<string>",
  "whatsappVerifiedName": "<string>",
  "whatsappProfilePictureUrl": "<string>",
  "whatsappQualityRating": "<string>",
  "instagramUsername": "<string>",
  "instagramProfileName": "<string>",
  "instagramProfilePictureUrl": "<string>",
  "connectionType": "<string>",
  "metaConnected": true,
  "forwardingEnabled": true,
  "forwardingDisabledReason": "<string>",
  "metaRetryDisabled": true,
  "credentialPublicId": "<string>",
  "webhookUrl": "<string>",
  "verifyToken": "<string>",
  "hmacSecret": "<string>"
}

{
  "statusCode": 403,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

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

Response

Channel detail (adds metaBusinessId, whatsappBusinessName)

string

ch_ publicId

type

enum<string>

Available options:

whatsapp,

instagram,

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. Use id (ch_...) for HookMyApp API calls and friendly fields for display.

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

connectionType

string

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

Get channel

curl --request GET \
  --url https://api.hookmyapp.com/meta/channels/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hookmyapp.com/meta/channels/{id}', 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/{id}",
  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>"
  ],
]);

$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/{id}"

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

	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/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "workspaceId": "<string>",
  "metaResourceId": "<string>",
  "metaWabaId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "whatsappWabaName": "<string>",
  "whatsappDisplayPhoneNumber": "<string>",
  "whatsappPhoneNumberId": "<string>",
  "whatsappVerifiedName": "<string>",
  "whatsappProfilePictureUrl": "<string>",
  "whatsappQualityRating": "<string>",
  "instagramUsername": "<string>",
  "instagramProfileName": "<string>",
  "instagramProfilePictureUrl": "<string>",
  "connectionType": "<string>",
  "metaConnected": true,
  "forwardingEnabled": true,
  "forwardingDisabledReason": "<string>",
  "metaRetryDisabled": true,
  "credentialPublicId": "<string>",
  "webhookUrl": "<string>",
  "verifyToken": "<string>",
  "hmacSecret": "<string>"
}

{
  "statusCode": 403,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>"
}

Customer Messaging

API Reference

Authorizations

Path Parameters

Response