Workspace · Webhooks
Returns webhooks.
https://api.pozy.ai/v1/webhooks/settingsGuides: Set up webhooks, Verify signatures, Retries and delivery logs
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the webhooks resource group disabled get 403 resource_group_disabled. Authentication
Example
curl -X GET "https://api.pozy.ai/v1/webhooks/settings" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/webhooks/settings", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
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.get(
"https://api.pozy.ai/v1/webhooks/settings",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
webhooksarray of object12 child fields
_idstringnamestringUp to 50 characters.
urlstring (URL)secretstringeventsarray of stringEach item: one 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,analytics.synced,post.tracking_completed,post.authenticity_changed,message.received,conversation.startedand 93 more.isActivebooleanlastFiredAtstring (date-time)failureCountintegercustomHeadersmap of stringdisabledResourceGroupsarray of stringEach item: one of
publishing,engagement,messages,contacts,analytics,ads,telephony,accounts,billing,webhooks,commerce,creator_campaigns,money,calendar,files.profileIdsarray of stringaccountIdsarray of string
{
"webhooks": [
{
"_id": "635d87e261ae344ef27fd1df",
"name": "Acme",
"url": "https://pozy.ai/media/example-1.jpg",
"secret": "string",
"events": [
"post.scheduled"
],
"isActive": true,
"lastFiredAt": "2026-10-02T09:00:00.000Z",
"failureCount": 42,
"customHeaders": {
"key": "string"
},
"disabledResourceGroups": [
"publishing"
],
"profileIds": [
"string"
],
"accountIds": [
"string"
]
}
]
}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 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.