Listar webhooks
Consulte os destinos cadastrados na empresa e no ambiente autenticado.
Consulte os cadastros disponíveis para a chave usada na requisição. A listagem apresenta a configuração dos destinos, sem retornar o segredo de assinatura.
Veja Consultar e alterar a configuração e Listagem e paginação.
Parâmetros de consulta
Quantidade de registros por página. A resposta informa o tamanho efetivo em page.page_size.
De 1 a 100
Para avançar, copie page.next_after da resposta anterior. Use apenas after ou before.
Até 128 caracteres
Para voltar, copie page.previous_before da resposta anterior. Use apenas after ou before.
Até 128 caracteres
Respostas
Corpo da resposta
Consulta concluída.
Página de webhooks cadastrados.
Webhooks desta página.
Identificador público do webhook.
Nome usado para identificar o destino.
URL HTTPS cadastrada para receber os eventos.
Códigos dos eventos assinados por este destino.
Indica se o webhook está ativo para receber eventos.
Motivo da desativação: manual para uma ação do cliente; continuous_failure pode aparecer em cadastros desativados anteriormente por falhas. Retorna null quando o webhook está ativo.
Instante da desativação, em segundos Unix UTC, ou null quando o webhook está ativo ou essa data não foi registrada.
Fim da validade do segredo anterior, em segundos Unix UTC, ou null quando não há transição vigente.
Instante do cadastro, em segundos Unix UTC.
Instante da última alteração do cadastro, em segundos Unix UTC.
Indica se os envios aguardam a retomada. O prazo original das entregas continua correndo durante a pausa.
Início da pausa atual, em segundos Unix UTC, ou null quando os envios não estão pausados.
Informações para continuar ou voltar na listagem.
Quantidade efetiva de registros por página.
Indica se há outra página para avançar.
Indica se há outra página para voltar.
Cursor para usar em after, ou null quando não há próxima página.
Cursor para usar em before, ou null quando não há página anterior.
Corpo da resposta
Um campo, filtro ou identificador está inválido. Confira os detalhes antes de repetir a requisição.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Para os erros gerais, consulte Códigos HTTP das respostas.