Skip to main content
GET
cURL

Escopo

Filtros Disponíveis

Filtros podem ser combinados para refinar ainda mais os resultados.Exemplo: ?event_id=purchase_approved&event_status=200 - Filtra eventos de compra aprovada que foram enviados com sucesso (status 200).
  • id - Id do histórico do evento
  • app_id - Id do app webhook
Suporte a múltiplos valores separados por vírgula.
Exemplo: ?id=123,456 - Filtra históricos com Id 123 ou 456
Suporte a múltiplos valores separados por vírgula.
Exemplo: ?event_id=purchase_approved,subscription_created - Filtra eventos de compra aprovada e assinatura criada
  • event_status - Código de status HTTP da resposta do webhook
Suporte a operadores de comparação (__gt, __gte, __lt, __lte)
Status 200-299 indicam sucesso, 400-499 erros do cliente, 500-599 erros do servidor.
Exemplos:
  • ?event_status=200 - Filtra eventos com status 200
  • ?event_status__gte=400 - Filtra eventos com erros (status >= 400)
  • dispatchedAt - Data e hora em que o evento foi enviado
Suporte a operadores de comparação (__gt, __gte, __lt, __lte)
Formato de data: YYYY-MM-DD ou ISO 8601 YYYY-MM-DDTHH:MM:SS±hh:mm
Exemplo: ?dispatchedAt__gte=2024-01-01&dispatchedAt__lt=2024-02-01 - Filtra eventos enviados em janeiro de 2024

Busca

O endpoint suporta busca textual pelo parâmetro search nos seguintes campos:
  • app.name - Nome do webhook
  • url - URL de destino do webhook
  • errors - Mensagens de erro do evento
Exemplo: ?search=timeout - Busca pelo texto “timeout” nos campos de busca. Qualquer histórico de evento onde um dos campos contenha o texto timeout será retornado.

Ordenação

Você pode ordenar os resultados usando o parâmetro ordering. Campos suportados: event_id, dispatchedAt, scheduledAt, sentAt
Use o prefixo - para ordenação decrescente.
Exemplo: ?ordering=-dispatchedAt - Ordena por data de envio (mais recentes primeiro)

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Query Parameters

limit
integer

Número de resultados a serem retornados por página.

page
integer

Número da página a ser retornada.

Response

Corpo da resposta status 200

count
integer
Example:

123

next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

results
object[]