Skip to main content
GET
Get default webhook

Overview

Returns the data of a default webhook of the workspace. As in the list, authentication credentials and the secret are not returned. An id from another workspace, of a channel webhook or of a template webhook gets 404, the same response as an id that does not exist.
The webhookId comes from the Create default webhook or List default webhooks response.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Path Parameters

webhookId
string
required

Default webhook ID

Example:

"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"

Response

Default webhook found

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