Deletar Webhook

Descrição: Remove um Webhook a partir do id

O header Content-Type: application/json é obrigatório, mesmo que a requisição não tenha corpo. Sem ele a API responde 415 Unsupported Media Type, sem corpo.

Endpoint

DELETE/api/v1/integration/webhooks/{id}

Regras

Atributos	Descrição	Tipo	Obrigatório
id	Identificador do webhook que será removido	string	Sim

O id não é devolvido pelo cadastro (POST /api/v1/integration/webhooks responde 201 sem corpo). Obtenha-o antes em GET /api/v1/integration/webhooks ou em GET /api/v1/integration/webhooks/-/events/{webhook_event}.

Exemplo de Requisição

cURL

curl -X DELETE \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  "https://api.merx.tech/api/v1/integration/webhooks/{id}"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String webhookId = "{id}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/webhooks/" + webhookId))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .DELETE()
    .build();

HttpClient client = HttpClient.newHttpClient();
try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const webhookId = '{id}';
const response = await fetch(
  `https://api.merx.tech/api/v1/integration/webhooks/${webhookId}`,
  {
    method: 'DELETE',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
  }
);
console.log(response.status);

Python

import requests

webhook_id = "{id}"
url = f"https://api.merx.tech/api/v1/integration/webhooks/{webhook_id}"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
id	Identificador do webhook que será removido	String	Sim

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim
Content-Type	application/json — exigido mesmo sem corpo; ausente ou incorreto resulta em 415 sem corpo	String	Sim

Respostas

• 204 - No Content

Sem corpo. É a resposta de todo DELETE aceito — inclusive quando nada é removido (id inexistente, id de outra cooperativa ou webhook já removido). A remoção é lógica (soft delete) e o endpoint não informa quantos registros foram afetados. Para confirmar a remoção, consulte GET /api/v1/integration/webhooks.

• 400 - Bad Request

O id informado no caminho não é um UUID válido:

{
  "timestamp": "2024-01-15T10:30:00.123",
  "status": 400,
  "error": "Bad Request",
  "message": "message.id.invalid"
}

• 401 - Unauthorized

Devolvido pelo gateway quando o Authorization está ausente ou inválido — nesse caso a resposta traz corpo, no formato {"data": [], "error": {...}}. A mensagem dentro de error varia conforme o plugin de autenticação da rota, então não programe em cima do texto.

• 415 - Unsupported Media Type

Sem corpo. Devolvido quando o header Content-Type: application/json não é enviado.

Este endpoint não retorna 404: remover um webhook inexistente também devolve 204.