Buscar Webhooks

Descrição: Retorna todos webhooks cadastrados

Endpoint

GET/api/v1/integration/webhooks

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/webhooks"

Java

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/webhooks"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .build();

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

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/webhooks',
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/webhooks"

headers = {
    "Authorization": "{SUA_API_KEY}",
}

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

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim

Respostas

• 200 - Ok

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "event": "CREATE_FARM",
    "url": "https://api.cliente.com/api/v1/receive",
    "basic_authentication": "dXN1YXJpbzpzZW5oYQ==",
    "created_at": 1709837511.870898,
    "updated_at": 1709837511.870898
  }
]

Campo	Observação
id	Identificador do webhook. É este o valor usado no DELETE /api/v1/integration/webhooks/{id} — o cadastro (POST) responde 201 sem corpo e não devolve o id.
basic_authentication	Retorna o valor como está armazenado, em Base64 (a API codifica no cadastro), e não o usuário:senha em texto claro. Decodifique em Base64 para conferir a credencial.
created_at / updated_at	Timestamps em epoch com segundos decimais (segundos desde 1970-01-01 UTC, com a fração após o ponto), e não em texto ISO-8601.

Campos nulos são omitidos da resposta. Um webhook cadastrado sem basic_authentication, por exemplo, volta sem essa chave.

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 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.

Esta listagem não retorna 404. Quando a cooperativa não tem nenhum webhook cadastrado, a resposta é 200 com um array vazio ([]).