JSON for Webhooks
When you configure webhooks, the system can send messages whenever certain actions occur—like publishing a page or recycling a file that include structured JSON data about the event. These messages let you connect CMS activity with external systems, automate processes, or trigger custom workflows.
For publish actions that trigger a webhook you can see the message payload sent in response. Use this information to understand what data is available and how it’s formatted before integrating webhooks into your site or third-party tools.
{
"finished": false,
"messages": [],
"error": false,
"key": "PUB:generic-account:support:example-site:12345:/gallena/faq.pcf",
"account": "generic-account",
"site": "example-site",
"user": "example-user",
"type": "page publish",
"success": {},
"failed": {},
"errors": {},
"no_publish": {},
"success_count": 0,
"failed_count": 0,
"uuid": "00000000-0000-0000-0000-000000000000",
"began": "2025-10-16T19:15:35Z",
"completed": null,
"origin": [
"/gallena/faq.pcf"
],
"total_time": 0,
"msg": "publish has begun"
}
{
"finished": true,
"messages": [],
"error": false,
"key": "PUB:generic-account:support:example-site:12345:/gallena/faq.pcf",
"account": "generic-account",
"site": "example-site",
"user": "example-user",
"type": "page publish",
"success": {
"example-site": [
{
"path": "/gallena/faq.pcf",
"url": "https://support.example.com/gallena/faq.html"
}
]
},
"failed": {},
"errors": {},
"no_publish": {},
"success_count": 1,
"failed_count": 0,
"uuid": "00000000-0000-0000-0000-000000000000",
"began": "2025-10-16T19:15:35Z",
"completed": "2025-10-16T19:15:36Z",
"origin": [
"/gallena/faq.pcf"
],
"total_time": 1329,
"msg": "publish has completed"
}