Criar webhook de template

curl --request POST \
  --url https://api.omni.z-api.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://app.suaempresa.com/webhooks/templates",
  "description": "Webhook de template",
  "events": [
    "UPDATE_TEMPLATE_STATUS",
    "UPDATE_TEMPLATE_CATEGORY"
  ],
  "signing": false,
  "authType": "NONE"
}
'

{
  "id": "8F2C00000000000000000000000000A1",
  "channelId": null,
  "instanceId": null,
  "url": "https://app.suaempresa.com/webhooks/templates",
  "description": "Webhook de template",
  "events": [
    "UPDATE_TEMPLATE_STATUS",
    "UPDATE_TEMPLATE_CATEGORY"
  ],
  "status": "ENABLED",
  "signing": false,
  "secret": null,
  "auth": {
    "type": "NONE",
    "configured": false
  },
  "payloadFormat": "DEFAULT",
  "customAttributes": {},
  "createdAt": "2026-07-15T19:00:00.000+00:00",
  "updatedAt": "2026-07-15T19:00:00.000+00:00"
}

POST

webhooks

curl --request POST \
  --url https://api.omni.z-api.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://app.suaempresa.com/webhooks/templates",
  "description": "Webhook de template",
  "events": [
    "UPDATE_TEMPLATE_STATUS",
    "UPDATE_TEMPLATE_CATEGORY"
  ],
  "signing": false,
  "authType": "NONE"
}
'

{
  "id": "8F2C00000000000000000000000000A1",
  "channelId": null,
  "instanceId": null,
  "url": "https://app.suaempresa.com/webhooks/templates",
  "description": "Webhook de template",
  "events": [
    "UPDATE_TEMPLATE_STATUS",
    "UPDATE_TEMPLATE_CATEGORY"
  ],
  "status": "ENABLED",
  "signing": false,
  "secret": null,
  "auth": {
    "type": "NONE",
    "configured": false
  },
  "payloadFormat": "DEFAULT",
  "customAttributes": {},
  "createdAt": "2026-07-15T19:00:00.000+00:00",
  "updatedAt": "2026-07-15T19:00:00.000+00:00"
}

Conceituação

Cria um webhook de template. Ele não depende de uma instância — o instanceId é gravado como null automaticamente — e recebe apenas os eventos de template do WhatsApp. O campo events aceita somente UPDATE_TEMPLATE_STATUS e UPDATE_TEMPLATE_CATEGORY. Qualquer evento não-template resulta em 422.

`payloadFormat` é ignorado

Para webhooks de template o formato é sempre DEFAULT. Você pode omitir o campo; se enviado (qualquer valor), ele é silenciosamente descartado e persistido como DEFAULT.

Assinatura HMAC

Se signing: true, o campo secret é gerado e retornado apenas nesta resposta. Armazene-o com segurança — ele não será exibido novamente. A assinatura chega no header x-webhook-signature e é calculada sobre uma string canônica de cinco campos — não apenas sobre o corpo. Veja Assinatura HMAC.

Validações

O pedido é recusado com 400, sem gravar nada, nestes casos:

Caso	Resposta
`url` ausente ou em branco	`{"error": "URL is required"}`
`url` fora do formato, ou com host que não resolve só para endereços públicos	veja URL do webhook
`events` ausente ou vazio	`{"error": "At least one event is required"}`
Item de `events` nulo, em branco ou com nome que não existe	`{"error": "events contains an unknown or empty event name"}`
`auth.type` `CUSTOM_HEADER` sem `auth.headerName`	`{"error": "Header name is required for CUSTOM_HEADER auth type"}`
Autenticação diferente de `NONE` sem a credencial do tipo	`{"error": "Credentials are required when auth type is not NONE"}`

O nome do evento é aceito em maiúsculas ou minúsculas. A resposta de nome inválido não repete o valor enviado.

Após a criação, o roteamento pode levar até ~5 min para refletir (TTL de cache).

Autorizações

Authorization

string

header

obrigatório

Secret Key gerada no painel de Segurança do Omni Z-API

Corpo

application/json

url

string

obrigatório

URL de destino dos eventos: absoluta, http ou https, com até 2048 caracteres. O host precisa existir no DNS e resolver só para endereços públicos; senão, 400.

Exemplo:

"https://app.suaempresa.com/webhooks/templates"

events

enum<string>[]

obrigatório

Somente eventos de template. Pelo menos um obrigatório. Qualquer evento não-template resulta em 422; nome inexistente, nulo ou em branco resulta em 400.

Minimum array length: 1

Eventos de template aceitos: UPDATE_TEMPLATE_STATUS (atualização de status do template — aprovado/rejeitado etc.) e UPDATE_TEMPLATE_CATEGORY (atualização de categoria do template).

Opções disponíveis:

UPDATE_TEMPLATE_STATUS,

UPDATE_TEMPLATE_CATEGORY

Exemplo:

[
  "UPDATE_TEMPLATE_STATUS",
  "UPDATE_TEMPLATE_CATEGORY"
]

description

string

Descrição opcional do webhook

Exemplo:

"Webhook de template"

signing

boolean

padrão:false

Habilita assinatura HMAC-SHA256. Quando true, gera e retorna um secret de 64 caracteres hex apenas na criação/atualização.

Exemplo:

false

authType

enum<string>

padrão:NONE

Tipo de autenticação (forma plana). Alternativa ao objeto auth.

Opções disponíveis:

NONE,

BEARER,

API_KEY,

BASIC,

CUSTOM_HEADER

Exemplo:

"NONE"

token

string

Credencial para BEARER (forma plana)

key

string

Credencial para API_KEY (forma plana)

auth

object

Forma aninhada da autenticação. Para BASIC use username+password; para CUSTOM_HEADER use headerName+headerValue.

Show child attributes

payloadFormat

enum<string>

padrão:DEFAULT

Ignorado para webhooks de template — o formato é sempre DEFAULT. Pode ser omitido; se enviado (qualquer valor), é descartado e persistido como DEFAULT.

Opções disponíveis:

DEFAULT

Exemplo:

"DEFAULT"

customAttributes

object

Mapa livre de atributos extras

Exemplo:

{}

Resposta

Webhook de template criado com sucesso. channelId e instanceId vêm null. O campo secret é retornado apenas nesta resposta quando signing é true.

string

ID único do webhook de template

Exemplo:

"8F2C00000000000000000000000000A1"

channelId

string | null

Sempre null para webhooks de template

Exemplo:

null

instanceId

string | null

obsoleto

Descontinuado e sempre null para webhooks de template

Exemplo:

null

url

string

URL de destino dos eventos

Exemplo:

"https://app.suaempresa.com/webhooks/templates"

description

string | null

Descrição do webhook

Exemplo:

"Webhook de template"

events

enum<string>[]

Eventos de template configurados Evento gravado que a API ainda não conhece não aparece aqui.

Eventos de template aceitos: UPDATE_TEMPLATE_STATUS (atualização de status do template — aprovado/rejeitado etc.) e UPDATE_TEMPLATE_CATEGORY (atualização de categoria do template).

Opções disponíveis:

UPDATE_TEMPLATE_STATUS,

UPDATE_TEMPLATE_CATEGORY

Exemplo:

[
  "UPDATE_TEMPLATE_STATUS",
  "UPDATE_TEMPLATE_CATEGORY"
]

status

enum<string>

Status atual do webhook

Opções disponíveis:

ENABLED,

DISABLED

Exemplo:

"ENABLED"

signing

boolean

Indica se a assinatura HMAC está habilitada

Exemplo:

false

auth

object

Resumo da autenticação configurada — credenciais não são retornadas por segurança

Show child attributes

payloadFormat

enum<string>

Sempre DEFAULT para webhooks de template

Opções disponíveis:

DEFAULT

Exemplo:

"DEFAULT"

customAttributes

object

Exemplo:

{}

createdAt

string<date-time>

Exemplo:

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

updatedAt

string<date-time>

Exemplo:

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

secret

string | null

Segredo HMAC de 64 caracteres hex — retornado apenas quando signing = true no create/update. null quando a assinatura está desabilitada. Não poderá ser recuperado depois.

Exemplo:

null

Canais

Mensagens

Templates (WhatsApp)

Flows (WhatsApp)

Webhooks

Criar webhook de template

Conceituação

`payloadFormat` é ignorado

Assinatura HMAC

Validações

Autorizações

Corpo

Resposta

​Conceituação

​payloadFormat é ignorado

​Assinatura HMAC

​Validações

Autorizações

Corpo

Resposta

Conceituação

`payloadFormat` é ignorado

Assinatura HMAC

Validações