Skip to content

Get Webhook GET

Retrieve details of a specific webhook by its unique identifier.

Endpoint

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

Authentication

Required

Include one of these headers in your request:

  • Token: <your-api-key> — Get it from API Keys
  • Authorization: Bearer <jwt-token> — From Login

Request

Path Parameters

ParameterTypeRequiredDescription
tidstringWebhook unique identifier

Headers

HeaderRequiredDescription
TokenYour API key
AuthorizationBearer <jwt-token>

Example Request

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

tid = 'kblf7mh9j8jjyeh4fx'
response = requests.get(
    f'https://api.pocketalert.app/v1/webhooks/{tid}',
    headers={'Token': 'your-api-key'}
)
print(response.json())
php
$tid = 'kblf7mh9j8jjyeh4fx';
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/webhooks/'.$tid);

return $response->json();

Response

Success Response

200 OK

Returns the webhook object

FieldTypeDescription
tidstringUnique webhook identifier
namestringWebhook name
urlstringWebhook URL slug
messagestringMessage template
is_activebooleanWhether webhook is active
created_atstringCreation timestamp
json
{
  "tid": "kblf7mh9j8jjyeh4fx",
  "name": "GitHub Push",
  "url": "cs994rqfkk8ljngt",
  "message": "Push to %repository.name%: %head_commit.message%",
  "is_active": true,
  "created_at": "01.09.2023 22:38:48"
}

Error Responses

StatusDescription
401Unauthorized — Invalid or missing token
404Not Found — Webhook does not exist

Pocket Alert Documentation