Remover webhook de template

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

const options = {method: 'DELETE', 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 => "DELETE",
  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("DELETE", 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::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "error": "Webhook not found"
}

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

DELETE

webhooks

{webhookId}

Remover webhook de template

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

const options = {method: 'DELETE', 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 => "DELETE",
  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("DELETE", 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::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "error": "Webhook not found"
}

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

Conceituação

Remove permanentemente um webhook de template. Após a exclusão, o para imediatamente de enviar eventos de template para a URL configurada.

A exclusão é permanente. Se precisar apenas pausar o webhook temporariamente, use o endpoint Atualizar webhook de template com status: "DISABLED" em vez de deletar.

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

Webhook removido com sucesso. Nenhum conteúdo retornado.

Canais

Mensagens

Templates (WhatsApp)

Flows (WhatsApp)

Webhooks

Remover webhook de template

Conceituação

Autorizações

Parâmetros de caminho

Resposta

​Conceituação

Autorizações

Parâmetros de caminho

Resposta

Conceituação