Detalhar webhook de template

curl --request GET \
  --url https://api.omni.z-api.io/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.omni.z-api.io/v1/webhooks/{webhookId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.omni.z-api.io/v1/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omni.z-api.io/v1/webhooks/{webhookId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/v1/webhooks/{webhookId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "8F2C00000000000000000000000000A1",
  "channelId": null,
  "instanceId": null,
  "url": "https://destino/webhook",
  "description": "Webhook de template",
  "events": [
    "UPDATE_TEMPLATE_STATUS"
  ],
  "status": "ENABLED",
  "signing": false,
  "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"
}

{
  "error": "Webhook not found"
}

{
  "error": "This action requires ENTERPRISE role"
}

GET

webhooks

{webhookId}

Detalhar webhook de template

curl --request GET \
  --url https://api.omni.z-api.io/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.omni.z-api.io/v1/webhooks/{webhookId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.omni.z-api.io/v1/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omni.z-api.io/v1/webhooks/{webhookId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/v1/webhooks/{webhookId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "8F2C00000000000000000000000000A1",
  "channelId": null,
  "instanceId": null,
  "url": "https://destino/webhook",
  "description": "Webhook de template",
  "events": [
    "UPDATE_TEMPLATE_STATUS"
  ],
  "status": "ENABLED",
  "signing": false,
  "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"
}

{
  "error": "Webhook not found"
}

{
  "error": "This action requires ENTERPRISE role"
}

Conceituação

Retorna os dados de um webhook de template específico do tenant. Assim como na listagem, as credenciais de autenticação e o secret não são retornados por segurança.

O webhookId é obtido no retorno do endpoint Criar webhook de template ou Listar webhooks de template.

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

webhookId

string

obrigatório

ID do webhook de template

Exemplo:

"8F2C00000000000000000000000000A1"

Resposta

Dados do webhook de template

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://destino/webhook"

description

string | null

Descrição do webhook

Exemplo:

"Webhook de template"

events

enum<string>[]

Eventos de template configurados

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"

Canais

Mensagens

Templates (WhatsApp)

Flows (WhatsApp)

Webhooks

Detalhar webhook de template

Conceituação

Autorizações

Parâmetros de caminho

Resposta

​Conceituação

Autorizações

Parâmetros de caminho

Resposta

Conceituação