Webhooks

List webhook endpoints

GET /api/v1/webhooks

API key access: Read only or read and write
Project permission: None — acts on your own account
Success: 200 — OK

Example request

Replace tk_live_YOUR_KEY with your API key.

curl 'https://trackerv2.marketingplanet.global/api/v1/webhooks' \
  -H 'Authorization: Bearer tk_live_YOUR_KEY'

const response = await fetch('https://trackerv2.marketingplanet.global/api/v1/webhooks', {
  headers: {
    Authorization: 'Bearer tk_live_YOUR_KEY',
  },
});

const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result.data);

import requests

response = requests.get(
    "https://trackerv2.marketingplanet.global/api/v1/webhooks",
    headers={"Authorization": "Bearer tk_live_YOUR_KEY"},
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result["data"])

Example response

200 OK

{
  "data": [
    {
      "id": "6655f9b7d6a8c0e2f4b6d801",
      "url": "https://hooks.acmeretail.com/tracker",
      "description": "Ops channel",
      "events": [
        "uptime.down",
        "uptime.recovered"
      ],
      "projectIds": [
        "6650a4c2e1b3d5f7a9c1e301"
      ],
      "enabled": true,
      "disabledReason": null,
      "consecutiveFailures": 0,
      "lastDeliveryAt": "2026-10-06T09:20:44.000Z",
      "lastSuccessAt": "2026-10-06T09:20:44.000Z",
      "createdAt": "2026-09-12T08:00:00.000Z",
      "updatedAt": "2026-10-06T09:20:44.000Z"
    }
  ]
}

Response fields

Field	Type	Notes
`data`	array of WebhookEndpoint
`data[].id`	string
`data[].url`	string
`data[].description`	string
`data[].events`	array of "uptime.down" \| "uptime.still_down" \| "uptime.recovered" \| "finding.opened" \| "finding.resolved"
`data[].projectIds`	array of string
`data[].enabled`	boolean
`data[].disabledReason`	string or null
`data[].consecutiveFailures`	integer
`data[].lastDeliveryAt`	string (date-time) or null
`data[].lastSuccessAt`	string (date-time) or null
`data[].createdAt`	string (date-time)
`data[].updatedAt`	string (date-time)

Errors

Only the errors any request can return: a missing or invalid key, no API access on your plan, or the rate limit.

Errors always look like { "error": { "code": "…", "message": "…" } }. See Errors & limits.