Workspace · Webhooks
Sends a test webhook.
https://api.pozy.ai/v1/webhooks/testGuides: Test webhooks, Set up webhooks, Route webhooks to tenants
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the webhooks resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
webhookIdstringrequiredeventstringOne of
post.scheduled,post.published,post.failed,post.partial,post.cancelled,post.recycled,post.platform.published,post.platform.failed,post.platform.deleted,post.tiktok.url_resolved,post.external.created,post.external.updated,post.external.deleted,account.connected,account.disconnected,account.permissions_changed,account.ads.initial_sync_completed,account.ads.sync_failed,account.ads.sync_recovered,account.rate_limited,calendar.event.created,calendar.event.updated,calendar.event.deleted,file.createdand 93 more.
Example
curl -X POST "https://api.pozy.ai/v1/webhooks/test" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"webhookId": "6dac06b11de029319072e830"
}'const res = await fetch("https://api.pozy.ai/v1/webhooks/test", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
webhookId: "6dac06b11de029319072e830"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/webhooks/test",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"webhookId": "6dac06b11de029319072e830",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanmessagestring
{
"success": true,
"message": "Hello from Pozy"
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.