Webhooks

Send a test event

POST /api/v1/webhooks/{webhookId}/test

Queues a webhook.test event to this endpoint. Check the result in its deliveries. Tests and redeliveries are limited to one per endpoint every 10 seconds (429 send-cooldown) and 20 per minute per account (429 send-rate-limited).

API key access: Read and write
Project permission: None — acts on your own account
Success: 202 — Queued

Parameters

Path

Parameter	Type	Notes
`webhookId` required	string

Example request

Replace tk_live_YOUR_KEY with your API key and the ids with your own.

curl -X POST 'https://trackerv2.marketingplanet.global/api/v1/webhooks/6655f9b7d6a8c0e2f4b6d801/test' \
  -H 'Authorization: Bearer tk_live_YOUR_KEY'

const response = await fetch('https://trackerv2.marketingplanet.global/api/v1/webhooks/6655f9b7d6a8c0e2f4b6d801/test', {
  method: 'POST',
  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.post(
    "https://trackerv2.marketingplanet.global/api/v1/webhooks/6655f9b7d6a8c0e2f4b6d801/test",
    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

202 Accepted

{
  "data": {
    "id": "6656a0c8e7b9d1f3a5c7e901",
    "endpointId": "6655f9b7d6a8c0e2f4b6d801",
    "eventId": "evt_3c5e7a9b1d3f5a7c9e1b3d5f",
    "event": "webhook.test",
    "projectId": null,
    "status": "pending",
    "attempts": 0,
    "nextAttemptAt": "2026-10-06T09:30:00.000Z",
    "lastAttemptAt": null,
    "lastStatusCode": null,
    "lastError": null,
    "lastDurationMs": null,
    "deliveredAt": null,
    "createdAt": "2026-10-06T09:30:00.000Z"
  }
}

Response fields

Field	Type	Notes
`data`	object
`data.id`	string
`data.endpointId`	string
`data.eventId`	string
`data.event`	string
`data.projectId`	string or null
`data.status`	"pending" \| "delivering" \| "succeeded" \| "failed"
`data.attempts`	integer
`data.nextAttemptAt`	string (date-time) or null
`data.lastAttemptAt`	string (date-time) or null
`data.lastStatusCode`	integer or null
`data.lastError`	string or null
`data.lastDurationMs`	integer or null
`data.deliveredAt`	string (date-time) or null
`data.createdAt`	string (date-time)

Errors

Besides the errors any request can return (bad or missing key, plan, scope, rate limit), this endpoint can return:

Status	error.code	Meaning
404	`not-found`	The resource does not exist or you cannot open it. Tracker does not reveal which.
429	`send-cooldown`	A test or redelivery was sent to this endpoint in the last 10 seconds.
429	`send-rate-limited`	More than 20 test sends and redeliveries in the last minute on your account.

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