# 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

> **Info: Obrigatório**
>
> Inclua um destes cabeçalhos na sua requisição:
> - `Token: <your-api-key>` — Obtenha em [Chaves de API](https://pocketalert.app/account/apikeys)
> - `Authorization: Bearer <jwt-token>` — De [Login](https://info.pocketalert.app/api/user/login.md)

## Requisição

### Parâmetros de Caminho

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------|------|:--------:|-------------|
| `tid` | string | ✅ | Identificador único do webhook |

### Parâmetros de Consulta

| Parâmetro | Tipo | Padrão | Descrição |
|-----------|------|:-------:|-------------|
| `page` | integer | `1` | Número da página |
| `per` | integer | `50` | Itens por página (máximo `200`) |
| `status` | string | — | Filtra pelo resultado: `success` ou `error` |

### Exemplo de Requisição

**cURL**

```bash
curl -X GET "https://api.pocketalert.app/v1/webhooks/kblf7mh9j8jjyeh4fx/history?per=25&status=error" \
  -H "Token: your-api-key"
```

**JavaScript**

```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**

```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

> **Tip: 200 OK**
>
> Retorna uma lista paginada de requisições, da mais recente para a mais antiga

| Campo | Tipo | Descrição |
|-------|------|-------------|
| `requests` | array | Requisições registradas |
| `total` | integer | Total de requisições dentro do período de retenção |
| `page` | integer | Página atual |
| `per` | integer | Itens por página |
| `retention_days` | integer | Quantos dias de histórico o seu plano mantém (`0` = ilimitado) |
| `webhook` | object | `tid`, `name`, `url`, `is_active` |

Cada item em `requests`:

| Campo | Tipo | Descrição |
|-------|------|-------------|
| `id` | integer | Identificador da requisição |
| `method` | string | Método HTTP usado pelo remetente |
| `source_ip` | string | Endereço IP de quem fez a chamada |
| `content_type` | string | Tipo de conteúdo da requisição |
| `query` | string | String de consulta bruta |
| `headers` | object | Cabeçalhos da requisição (os sensíveis são ocultados) |
| `body` | string | Payload da requisição |
| `size` | integer | Tamanho do payload em bytes |
| `status` | string | `success` ou `error` |
| `error_code` | string | Motivo da falha; vazio em caso de sucesso |
| `rendered_message` | string | Mensagem gerada a partir do seu template |
| `message_tid` | string | Identificador da mensagem criada; vazio em caso de falha |
| `priority` | integer | Nível de alerta resolvido |
| `duration_ms` | integer | Tempo de processamento |
| `created_at` | string | Quando 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ódigo | Significado |
|------|---------|
| `inactive` | O webhook está desativado, então nenhum alerta foi enviado |
| `invalid_json` | O payload não pôde ser interpretado como JSON |
| `empty_message` | O template resultou em uma string vazia — geralmente um `%path%` que não existe no payload |
| `encryption_failed` | A mensagem não pôde ser criptografada |
| `save_failed` | A mensagem não pôde ser armazenada |
| `daily_limit` | Foi atingido o [limite diário de mensagens](https://info.pocketalert.app/features/daily-limits.md) da conta. A chamada recebeu `429` e nenhum alerta foi enviado; o payload e a mensagem renderizada são mantidos aqui |

### Respostas de Erro

| Status | Descrição |
|:------:|-------------|
| `401` | Não autorizado — token inválido ou ausente |
| `404` | Não encontrado — o webhook não existe |

## Observações

> **Warning: 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.

> **Info: 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.
