Skip to main content
GET
Esta rota lista os endpoints de webhook cadastrados em uma conta, pelo painel ou pela API. É por ela que você descobre o id de um endpoint, necessário para editar ou excluir, e confere quais eventos cada um recebe.

Quando usar

Antes de chamar

  • Use a chave secreta (sk_) em Basic (Credenciais e ambientes). A chave age com as permissões do usuário que a gerou: um perfil sem permissão de webhooks recebe 403 Acesso negado.
  • Tenha o id da conta: a sua própria ou, para a conta master, o de uma subconta que ela criou.

Parâmetros de consulta

string
required
Id da conta cujos endpoints serão listados. Obrigatório para credenciais de conta: sem ele, a resposta é 403. Ex.: 3Fq9TzL2mWc8VbN1xR7pK4hJ6sD.
Termo de busca. Ex.: meusite.
integer
Número da página, começando em 1.
integer
Quantidade de itens por página. Ex.: 20.

Respostas

A resposta 200 traz a página de endpoints e os totais. Diferente do corpo da criação, os itens vêm em camelCase.
object[]
required
Endpoints da página.
integer
required
Total de endpoints que atendem aos filtros, somando todas as páginas.
integer
required
Página devolvida.
integer
required
Itens por página.
integer
required
Total de páginas.
Mensagens literais da API (trate o erro pelo código HTTP, não pelo texto):

Erros comuns

Veja também

Criar endpoint

Cadastre um endpoint com filtro de eventos.

Atualizar endpoint

Troque a URL ou os eventos.

Excluir endpoint

Pare de enviar eventos para uma URL.

Webhooks: visão geral

Quem recebe cada evento e em que formato.