Skip to main content
GET
List template webhooks

Overview

Returns the tenant’s enabled template webhooks, scoped by the Authorization header — there is no cross-tenant access. Authentication credentials and the signing secret are not returned for security reasons.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Response

List of the tenant's template webhooks

id
string

Unique template webhook ID

Example:

"8F2C00000000000000000000000000A1"

channelId
string | null

Always null for template webhooks

Example:

null

instanceId
string | null
deprecated

Deprecated and always null for template webhooks

Example:

null

url
string

Destination URL for the events

Example:

"https://destination/webhook"

description
string | null

Webhook description

Example:

"Template webhook"

events
enum<string>[]

Configured template events

Accepted template events: UPDATE_TEMPLATE_STATUS (template status update — approved/rejected etc.) and UPDATE_TEMPLATE_CATEGORY (template category update).

Available options:
UPDATE_TEMPLATE_STATUS,
UPDATE_TEMPLATE_CATEGORY
Example:
status
enum<string>

Current webhook status

Available options:
ENABLED,
DISABLED
Example:

"ENABLED"

signing
boolean

Indicates whether HMAC signing is enabled

Example:

false

auth
object

Summary of the configured authentication — credentials are not returned for security reasons

payloadFormat
enum<string>

Always DEFAULT for template webhooks

Available options:
DEFAULT
Example:

"DEFAULT"

customAttributes
object
Example:
createdAt
string<date-time>
Example:

"2026-07-15T19:00:00.000+00:00"

updatedAt
string<date-time>
Example:

"2026-07-15T19:00:00.000+00:00"