Skip to main content
GET
/
v1
/
channels
/
{channelId}
/
webhooks
List webhooks
curl --request GET \
  --url https://api.hubmessage.io/v1/channels/{channelId}/webhooks \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "A1B2C3D4E5F6789012345678901234AB",
    "instanceId": "019E4C54B1B375A28970B605CA9B03C3",
    "url": "https://app.yourcompany.com/webhooks/hubmessage",
    "description": "Main production webhook",
    "events": [
      "MESSAGE_RECEIVED",
      "MESSAGE_STATUS"
    ],
    "status": "ENABLED",
    "signing": true,
    "auth": {
      "type": "BEARER",
      "configured": true
    },
    "payloadFormat": "DEFAULT",
    "customAttributes": {},
    "createdAt": "2025-01-15T10:30:00.000+0000",
    "updatedAt": "2025-01-15T10:30:00.000+0000"
  },
  {
    "id": "B2C3D4E5F6789012345678901234AB12",
    "instanceId": "019E4C54B1B375A28970B605CA9B03C3",
    "url": "https://app.yourcompany.com/webhooks/connection-events",
    "description": "Connection events",
    "events": [
      "CONNECTED",
      "DISCONNECTED"
    ],
    "status": "ENABLED",
    "signing": false,
    "auth": {
      "type": "NONE",
      "configured": false
    },
    "payloadFormat": "DEFAULT",
    "customAttributes": {},
    "createdAt": "2025-01-16T08:00:00.000+0000",
    "updatedAt": "2025-01-16T08:00:00.000+0000"
  }
]

​
Overview

Returns all webhooks registered on a channel. The auth.configured field indicates whether authentication credentials are set, but the credentials themselves are not returned for security reasons. The secret field (HMAC signing) is also not returned in the list — it is only available at the time of creation or when updating with signing: true.
This endpoint requires the ENTERPRISE role on your account.

Authorizations

​
Authorization
string
header
required

Secret Key generated in the Hub Message Security panel

Path Parameters

​
channelId
string
required

Channel ID

Example:

"019E4C54B1B375A28970B605CA9B03C3"

Response

List of channel webhooks

​
id
string

Unique webhook ID

Example:

"A1B2C3D4E5F6789012345678901234AB"

​
instanceId
string

ID of the channel this webhook belongs to

Example:

"019E4C54B1B375A28970B605CA9B03C3"

​
url
string

Event destination URL

Example:

"https://app.yourcompany.com/webhooks/hubmessage"

​
description
string | null

Webhook description

Example:

"Main production webhook"

​
events
string[]

Configured event types

Example:
["MESSAGE_RECEIVED", "MESSAGE_STATUS"]
​
status
enum<string>

Current webhook status

Available options:
ENABLED,
DISABLED
Example:

"ENABLED"

​
signing
boolean

Indicates whether HMAC signing is enabled

Example:

true

​
auth
object

Summary of configured authentication — credentials are not returned for security

​
payloadFormat
enum<string>

Delivered payload format

Available options:
DEFAULT,
Z_API
Example:

"DEFAULT"

​
customAttributes
object

Configured extra attributes

Example:
{}
​
createdAt
string<date-time>

Creation date

Example:

"2025-01-15T10:30:00.000+0000"

​
updatedAt
string<date-time>

Last update date

Example:

"2025-01-15T10:30:00.000+0000"