Skip to main content
GET
List default webhooks

Overview

Returns the default webhooks of the secret key’s workspace, enabled and disabled. Channel webhooks and template webhooks are not in this list. The auth.configured field tells whether an authentication credential is configured, but the credential itself is not returned. The HMAC signing secret is not returned either: it only appears in the response that generated it.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Response

The workspace's default webhooks

id
string

Default webhook ID

Example:

"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"

channelId
string | null

Always null: the default webhook does not belong to a channel

Example:

null

instanceId
string | null
deprecated

Always null. Legacy field, kept for compatibility

Example:

null

url
string
Example:

"https://app.yourcompany.com/webhooks/omni-zapi"

description
string | null
Example:

"Events from all channels"

events
enum<string>[]
Available options:
MESSAGE_RECEIVED,
MESSAGE_DELIVERY,
MESSAGE_STATUS,
RECEIVED_STATUS,
RECEIVED_AND_DELIVERY,
CONNECTED,
DISCONNECTED,
PRESENCE_CHAT,
INITIAL_DATA,
BLOCK
status
enum<string>

ENABLED or DISABLED

Available options:
ENABLED,
DISABLED
signing
boolean

true when HMAC signing is on

auth
object

Summary of the configured authentication. Credentials are not returned.

payloadFormat
enum<string>
Available options:
DEFAULT,
Z_API
customAttributes
object
createdAt
string<date-time>

Creation date

updatedAt
string<date-time>

Last update date