Skip to content

Get All Webhooks GET

Retrieve a list of all webhooks configured in your account.

Endpoint

GET https://api.pocketalert.app/v1/webhooks

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

Headers

HeaderRequiredDescription
TokenYour API key
AuthorizationBearer <jwt-token>

Example Request

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

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

return $response->json();

Response

Success Response

200 OK

Returns an array of webhook objects

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

Pocket Alert Documentation