GET/api/v2/cobranca/webhooks/{chave}

Listar

Lista webhooks cadastrados para a chave Pix. Cada item inclui id (necessário para PATCH/DELETE). Filtro opcional eventos (array): pagamento, pagamento-falha, recebimento, devolucao. Sem filtro, retorna todos os eventos.

Parâmetros

AcceptObrigatório
header

Define o formato esperado na resposta. Deve ser application/json

Tipo:string
AuthorizationObrigatório
header

Token de acesso no formato Bearer {access_token} para autenticação

Tipo:string
chaveObrigatório
path

Chave Pix para filtrar os webhooks

Tipo:string
eventosOpcional
query

Tipos de eventos para filtrar. Omita para listar todos.

Tipo:string[]

Descrição dos Campos da Resposta

NomeTipoDescrição
webhooksArrayLista dos webhooks registrados para a chave especificada.
webhooks.chaveStringChave Pix vinculada ao webhook.
webhooks.webhookUrlStringURL configurada para receber notificações do webhook.
webhooks.eventoStringEvento monitorado: recebimento ou pagamento.
webhooks.criacaoStringData e hora de criação do webhook (formato ISO 8601).
correlationIdStringIdentificador único da requisição para rastreabilidade.
currentPageInteiroPágina atual na paginação dos resultados.
lastPageInteiroNúmero da última página disponível.
perPageInteiroNúmero de itens por página.
fromInteiroPrimeiro item exibido na página atual.
toInteiroÚltimo item exibido na página atual.
totalInteiroTotal de itens disponíveis.
pathStringURL base para consulta do recurso.
firstPageUrlStringURL para a primeira página de resultados.
prevPageUrlStringURL para a página anterior (ou null se não houver).
nextPageUrlStringURL para a próxima página (ou null se não houver).

Códigos de Resposta

CódigoSignificadoDescrição
200OKConsulta realizada com sucesso.
400Bad RequestParâmetros inválidos ou faltando na requisição.
401UnauthorizedToken de autenticação inválido ou expirado.
404Not FoundNenhum webhook encontrado para a chave especificada.
500Internal Server ErrorErro interno no servidor. Contate o suporte se o problema persistir.

Notas

  • Utilize a URL retornada no campo webhookUrl para validar ou testar o recebimento das notificações configuradas.
  • Certifique-se de substituir os placeholders ({{ chave }}, {{ access_token }}) pelos valores corretos ao implementar a requisição.
  • Eventos Pix: recebimento (guia) e pagamento (guia).
curl --location 'https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{ access_token }}'
const axios = require("axios");

const config = {
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}",
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{ access_token }}",
  },
};

axios(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });
import requests

url = "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}"

headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer {{ access_token }}'
}

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

print(response.text)
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer {{ access_token }}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
?>
{
  "webhooks": [
    {
      "chave": "e3fe4462-4c8e-42c1-8360-b41b404ae557",
      "webhookUrl": "https://integrador.exemplo.com.br/pix/recebimento",
      "evento": "recebimento",
      "criacao": "2024-12-26T15:17:24.000000Z"
    }
  ],
  "correlationId": "3b6b1583-144d-46c7-b333-44dceb1be344",
  "currentPage": 1,
  "lastPage": 1,
  "perPage": 10,
  "from": 1,
  "to": 1,
  "total": 1,
  "path": "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/e3fe4462-4c8e-42c1-8360-b41b404ae557",
  "firstPageUrl": "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/e3fe4462-4c8e-42c1-8360-b41b404ae557?page=1",
  "prevPageUrl": null,
  "nextPageUrl": null
}