Excluir Webhook

Metodo

DELETE https://oapi.ogmma.com.br/v1/webhooks/:id

Conceituacao

Este endpoint remove permanentemente um webhook configurado. Apos a exclusao, nenhum evento sera mais enviado para a URL associada e todos os logs de entrega desse webhook tambem serao removidos.

Esta acao e irreversivel. Caso deseje apenas interromper temporariamente o envio de eventos, utilize o endpoint de atualizacao para desativar o webhook definindo active: false.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Chave de autenticacao da API. Bearer {API_KEY}

Parametros de Rota

Atributo	Tipo	Obrigatorio	Descricao
id	string	Sim	ID do webhook a ser excluido.

Request

cURL

curl -X DELETE "https://oapi.ogmma.com.br/v1/webhooks/{id}" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.delete(
  'https://oapi.ogmma.com.br/v1/webhooks/{id}',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.delete(
    'https://oapi.ogmma.com.br/v1/webhooks/{id}',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

Response

200 - Webhook excluido com sucesso

{
  "message": "Webhook removido"
}

400 - ID invalido

{
  "error": "INVALID_OBJECT_ID",
  "message": "ID invalido"
}

401 - Nao autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token de autenticacao invalido ou ausente"
}

429 - Limite de requisicoes excedido

{
  "error": "RATE_LIMIT_EXCEEDED",
  "message": "Limite de requisicoes excedido. Tente novamente em alguns instantes.",
  "retryAfter": 60
}

Atencao

A exclusao de um webhook e permanente e nao pode ser desfeita. Se voce deseja apenas pausar o recebimento de eventos, considere desativar o webhook em vez de exclui-lo.