Ir para o conteúdo

Histórico de Webhook GET ​

Consulte o histórico de requisições recebidas por um webhook específico: o que foi enviado, o que foi renderizado e se um alerta foi entregue.

Endpoint ​

GET https://api.pocketalert.app/v1/webhooks/{tid}/history

Autenticação ​

Obrigatório

Inclua um destes cabeçalhos na sua requisição:

  • Token: <your-api-key> — Obtenha em Chaves de API
  • Authorization: Bearer <jwt-token> — De Login

Requisição ​

Parâmetros de Caminho ​

ParâmetroTipoObrigatórioDescrição
tidstring✅Identificador único do webhook

Parâmetros de Consulta ​

ParâmetroTipoPadrãoDescrição
pageinteger1Número da página
perinteger50Itens por página (máximo 200)
statusstring—Filtra pelo resultado: success ou error

Exemplo de Requisição ​

bash
curl -X GET "https://api.pocketalert.app/v1/webhooks/kblf7mh9j8jjyeh4fx/history?per=25&status=error" \
  -H "Token: your-api-key"
javascript
const tid = 'kblf7mh9j8jjyeh4fx';
const response = await fetch(`https://api.pocketalert.app/v1/webhooks/${tid}/history?per=25`, {
  headers: { 'Token': 'your-api-key' }
});
const history = await response.json();
python
import requests

tid = 'kblf7mh9j8jjyeh4fx'
response = requests.get(
    f'https://api.pocketalert.app/v1/webhooks/{tid}/history',
    headers={'Token': 'your-api-key'},
    params={'per': 25, 'status': 'error'}
)
print(response.json())

Resposta ​

Resposta de Sucesso ​

200 OK

Retorna uma lista paginada de requisições, da mais recente para a mais antiga

CampoTipoDescrição
requestsarrayRequisições registradas
totalintegerTotal de requisições dentro do período de retenção
pageintegerPágina atual
perintegerItens por página
retention_daysintegerQuantos dias de histórico o seu plano mantém (0 = ilimitado)
webhookobjecttid, name, url, is_active

Cada item em requests:

CampoTipoDescrição
idintegerIdentificador da requisição
methodstringMétodo HTTP usado pelo remetente
source_ipstringEndereço IP de quem fez a chamada
content_typestringTipo de conteúdo da requisição
querystringString de consulta bruta
headersobjectCabeçalhos da requisição (os sensíveis são ocultados)
bodystringPayload da requisição
sizeintegerTamanho do payload em bytes
statusstringsuccess ou error
error_codestringMotivo da falha; vazio em caso de sucesso
rendered_messagestringMensagem gerada a partir do seu template
message_tidstringIdentificador da mensagem criada; vazio em caso de falha
priorityintegerNível de alerta resolvido
duration_msintegerTempo de processamento
created_atstringQuando a requisição chegou
json
{
  "requests": [
    {
      "id": 412,
      "method": "POST",
      "source_ip": "140.82.115.16",
      "content_type": "application/json",
      "query": "",
      "headers": { "User-Agent": "GitHub-Hookshot", "Authorization": "[redacted]" },
      "body": "{\"repository\":{\"name\":\"pocketalert\"}}",
      "size": 38,
      "status": "success",
      "error_code": "",
      "rendered_message": "Push to pocketalert",
      "message_tid": "yrst1db64dbbe7euurpmanhdy",
      "priority": 1,
      "duration_ms": 24,
      "created_at": "18.07.2026 16:45:06"
    }
  ],
  "total": 1,
  "page": 1,
  "per": 50,
  "retention_days": 90,
  "webhook": {
    "tid": "kblf7mh9j8jjyeh4fx",
    "name": "GitHub Push",
    "url": "cs994rqfkk8ljngt",
    "is_active": true
  }
}

Códigos de Erro ​

Quando status for error, error_code explica o que aconteceu:

CódigoSignificado
inactiveO webhook está desativado, então nenhum alerta foi enviado
invalid_jsonO payload não pôde ser interpretado como JSON
empty_messageO template resultou em uma string vazia — geralmente um %path% que não existe no payload
encryption_failedA mensagem não pôde ser criptografada
save_failedA mensagem não pôde ser armazenada
daily_limitFoi atingido o limite diário de mensagens da conta. A chamada recebeu 429 e nenhum alerta foi enviado; o payload e a mensagem renderizada são mantidos aqui

Respostas de Erro ​

StatusDescrição
401Não autorizado — token inválido ou ausente
404Não encontrado — o webhook não existe

Observações ​

Retenção

O histórico é mantido por um número limitado de dias, dependendo do seu plano (veja retention_days): 7 dias no plano Gratuito, 30 no Starter, 90 no Medium e 365 no Large. Requisições mais antigas são removidas automaticamente, assim como as entradas mais antigas quando um único webhook ultrapassa 1.000 chamadas registradas.

Privacidade

Os payloads são criptografados em repouso com a sua chave pessoal, da mesma forma que o conteúdo das mensagens. Os cabeçalhos de Authorization, cookie e chave de API são substituídos por [redacted] antes do armazenamento.

Documentação do Pocket Alert