Detalhar webhook

Buscar webhook

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.omni.z-api.io/v1/channels/{channelId}/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/channels/{channelId}/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/channels/{channelId}/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/channels/{channelId}/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": "A1B2C3D4E5F6789012345678901234AB",
  "channelId": "019E4C54B1B375A28970B605CA9B03C3",
  "instanceId": "019E4C54B1B375A28970B605CA9B03C3",
  "url": "https://app.suaempresa.com/webhooks/omni-zapi",
  "description": "Webhook principal de produção",
  "events": [
    "MESSAGE_RECEIVED",
    "MESSAGE_STATUS"
  ],
  "status": "ENABLED",
  "signing": true,
  "auth": {
    "type": "BEARER",
    "configured": true
  },
  "payloadFormat": "DEFAULT",
  "customAttributes": {},
  "createdAt": "2025-01-15T10:30:00.000+0000",
  "updatedAt": "2025-01-15T10:30:00.000+0000"
}

{
  "error": 401,
  "message": "Unauthorized"
}

{
  "error": 404,
  "message": "Webhook not found"
}

{
  "error": 422,
  "message": "This action requires ENTERPRISE role"
}

GET

channels

{channelId}

webhooks

{webhookId}

Buscar webhook

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.omni.z-api.io/v1/channels/{channelId}/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/channels/{channelId}/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/channels/{channelId}/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/channels/{channelId}/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": "A1B2C3D4E5F6789012345678901234AB",
  "channelId": "019E4C54B1B375A28970B605CA9B03C3",
  "instanceId": "019E4C54B1B375A28970B605CA9B03C3",
  "url": "https://app.suaempresa.com/webhooks/omni-zapi",
  "description": "Webhook principal de produção",
  "events": [
    "MESSAGE_RECEIVED",
    "MESSAGE_STATUS"
  ],
  "status": "ENABLED",
  "signing": true,
  "auth": {
    "type": "BEARER",
    "configured": true
  },
  "payloadFormat": "DEFAULT",
  "customAttributes": {},
  "createdAt": "2025-01-15T10:30:00.000+0000",
  "updatedAt": "2025-01-15T10:30:00.000+0000"
}

{
  "error": 401,
  "message": "Unauthorized"
}

{
  "error": 404,
  "message": "Webhook not found"
}

{
  "error": 422,
  "message": "This action requires ENTERPRISE role"
}

Conceituação

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

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

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

channelId

string

obrigatório

ID do canal

Exemplo:

"019E4C54B1B375A28970B605CA9B03C3"

webhookId

string

obrigatório

ID do webhook

Exemplo:

"A1B2C3D4E5F6789012345678901234AB"

Resposta

Dados do webhook

string

ID único do webhook

Exemplo:

"A1B2C3D4E5F6789012345678901234AB"

channelId

string

ID do canal ao qual o webhook pertence

Exemplo:

"019E4C54B1B375A28970B605CA9B03C3"

instanceId

string

obsoleto

Descontinuado — use channelId

Exemplo:

"019E4C54B1B375A28970B605CA9B03C3"

url

string

URL de destino dos eventos

Exemplo:

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

description

string | null

Descrição do webhook

Exemplo:

"Webhook principal de produção"

events

string[]

Tipos de evento configurados

Exemplo:

["MESSAGE_RECEIVED", "MESSAGE_STATUS"]

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:

true

auth

object

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

Show child attributes

payloadFormat

enum<string>

Formato do payload entregue

Opções disponíveis:

DEFAULT,

Z_API,

CHATWOOT

Exemplo:

"DEFAULT"

customAttributes

object

Atributos extras configurados

Exemplo:

{}

createdAt

string<date-time>

Data de criação

Exemplo:

"2025-01-15T10:30:00.000+0000"

updatedAt

string<date-time>

Data da última atualização

Exemplo:

"2025-01-15T10:30:00.000+0000"

Canais

Mensagens

Templates (WhatsApp)

Flows (WhatsApp)

Webhooks

Conceituação

Autorizações

Parâmetros de caminho

Resposta

​Conceituação

Autorizações

Parâmetros de caminho

Resposta

Conceituação