Skip to main content
GET
Get webhook

Overview

Returns the data of a specific webhook. As with the list endpoint, authentication credentials and the signing secret are not returned for security reasons.
The webhookId is obtained from the Create webhook or List webhooks endpoint.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Path Parameters

channelId
string
required

Channel ID

Example:

"019E4C54B1B375A28970B605CA9B03C3"

webhookId
string
required

Webhook ID

Example:

"A1B2C3D4E5F6789012345678901234AB"

Response

Webhook data

id
string

Unique webhook ID

Example:

"A1B2C3D4E5F6789012345678901234AB"

channelId
string

ID of the channel this webhook belongs to

Example:

"019E4C54B1B375A28970B605CA9B03C3"

instanceId
string
deprecated

Deprecated — use channelId instead

Example:

"019E4C54B1B375A28970B605CA9B03C3"

url
string

Event destination URL

Example:

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

description
string | null

Webhook description

Example:

"Main production webhook"

events
string[]

Configured event types

Example:
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>

Format of the delivered payload

Available options:
DEFAULT,
Z_API,
CHATWOOT
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"