Atualizar webhook PUT
Atualize o nome, o template de mensagem, o nível padrão, os botões de ação ou o status de atividade de um webhook. Campos omitidos mantêm o valor atual.
Endpoint
PUT https://api.pocketalert.app/v1/webhooks/{tid}Autenticação
Obrigatório
Inclua um destes cabeçalhos na sua requisição:
Token: <your-api-key>— Obtenha em Chaves de APIAuthorization: Bearer <jwt-token>— De Login
Requisição
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tid | string | ✅ | Identificador único do webhook |
Cabeçalhos
| Cabeçalho | Obrigatório | Descrição |
|---|---|---|
Token | ✅ | Sua chave de API |
Authorization | ✅ | Bearer <jwt-token> |
Parâmetros do corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | ❌ | Novo nome |
url | string | ❌ | Novo slug da URL de recebimento https://p4a.me/wh/{url}. A URL antiga deixa de funcionar. Um slug já em uso retorna 409 |
message | string | ❌ | Novo template de mensagem |
is_active | boolean | ❌ | Ativa/desativa o webhook |
application_id | string | ❌ | Novo TID do aplicativo |
device_id | string | ❌ | Novo TID do dispositivo |
default_level | string | int | null | ❌ | Nível de prioridade padrão para as mensagens deste webhook quando o payload não tiver level: um nome (silent…critical) ou um int (-2..2). null remove o valor, para que o nível do aplicativo seja usado |
actions | string | ❌ | Template JSON de botões de ação com placeholders %field.path%, veja Criar webhook. "" remove os botões |
Desativando um webhook
Um webhook com is_active: false continua aceitando requisições recebidas e responde 200, mas nenhum alerta é criado. Essas chamadas são registradas em Histórico do webhook com error_code: inactive.
Exemplo de requisição
bash
curl -X PUT "https://api.pocketalert.app/v1/webhooks/kblf7mh9j8jjyeh4fx" \
-H "Token: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"name": "GitHub Push (Inactive)",
"is_active": false
}'javascript
const tid = 'kblf7mh9j8jjyeh4fx';
const response = await fetch(`https://api.pocketalert.app/v1/webhooks/${tid}`, {
method: 'PUT',
headers: {
'Token': 'your-api-key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'GitHub Push (Inactive)',
is_active: false
})
});python
import requests
tid = 'kblf7mh9j8jjyeh4fx'
response = requests.put(
f'https://api.pocketalert.app/v1/webhooks/{tid}',
headers={'Token': 'your-api-key'},
json={'name': 'GitHub Push (Inactive)', 'is_active': False}
)
print(response.json())php
$tid = 'kblf7mh9j8jjyeh4fx';
$response = Http::withHeaders([
'Token' => 'your-api-key',
])->put('https://api.pocketalert.app/v1/webhooks/'.$tid, [
'name' => 'GitHub Push (Inactive)',
'is_active' => false,
]);
return $response->json();Resposta
Resposta de sucesso
200 OK
Webhook atualizado com sucesso
json
{
"data": "success"
}Respostas de erro
| Status | Descrição |
|---|---|
400 | Requisição inválida — um default_level ou template actions inválido, ou um name ou message vazio |
401 | Não autorizado — token inválido ou ausente |
404 | Não encontrado — webhook, aplicativo ou dispositivo não existe |
409 | Conflito — o slug url já está em uso |