cURL
Webhooks
Listar Webhooks
Lista webhooks da sua conta com suporte a filtros, busca e paginação
GET
cURL
Escopo
Filtros Disponíveis
Filtros por Identificação
Filtros por Identificação
name- Nome do webhook (busca parcial case-insensitive)url- URL do webhook (busca parcial case-insensitive)
?name=Aprovado - Filtra webhooks cujo nome contém “Aprovado”Filtros por Status
Filtros por Status
status- Status do webhook (active, disabled, waiting_config)
?status=active,disabled - Filtra webhooks ativos ou desativadosFiltros por Eventos
Filtros por Eventos
events- IDs customizados dos eventos (múltiplos valores separados por vírgula)
?events=purchase_approved,checkout_abandonment - Filtra webhooks que escutam os eventos de Compra Aprovada ou Abandono de CheckoutFiltros por Datas
Filtros por Datas
createdAt- Data de criaçãoupdatedAt- Data de última atualização
Formato de data:
YYYY-MM-DD ou ISO 8601 YYYY-MM-DDTHH:MM:SS±hh:mm?createdAt__gte=2024-01-01&createdAt__lt=2024-02-01T23:59:59Z - Filtra produtos criados em janeiro de 2024Filtros por Relacionamentos
Filtros por Relacionamentos
products- IDs dos produtos (múltiplos valores suportados)
Filtra webhooks associados aos produtos especificados.
?products=123,456 - Filtra webhooks associados aos produtos 123 ou 456Busca
O endpoint suporta busca textual pelo parâmetrosearch nos seguintes campos:
name- Nome da integração webhookurl- URL da integração webhook
?search=meu-produto - Busca pelo texto “meu-produto” nos campos de busca.
Qualquer webhook onde um dos campos contenha o texto será retornado, (“meu-produto 2.0” e “Oferta B meu-produto” seriam retornadas).
Ordenação
Você pode ordenar os resultados usando o parâmetroordering.
Campos suportados: status, name, url, createdAt, updatedAt
Exemplo: ?ordering=-createdAt - Ordena por data de criação (mais recentes primeiro)Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Query Parameters
Número de resultados a serem retornados por página.
Número da página a ser retornada.
