Real-time events
Webhooks
Subscribe to events and receive real-time HTTP payloads when content is published, sites deploy, or integrations sync.
Available events
Vivreal fires webhooks for key lifecycle events across the platform.
- collectionObject.created — new content item created
- collectionObject.updated — content item modified
- collectionObject.deleted — content item removed
- site.deployed — site successfully deployed and live
- integration.synced — integration sync completed
Payload format
Every webhook delivers a consistent JSON payload with event type, group context, and event-specific data.
- event — the event type string
- groupID — which group triggered the event
- dbKey — the tenant database key
- data — event-specific payload (IDs, names, status)
- timestamp — ISO 8601 timestamp
Delivery
Webhooks are delivered via SQS for reliability — events are queued and delivered to your endpoint.
- HTTP POST to your configured webhook URL
- X-Webhook-Secret header for signature verification
- Delivered via SQS queue for guaranteed delivery
- Retry on failure with backoff
Use cases
Automate workflows triggered by content and platform changes.
- Rebuild a static site when content changes
- Notify your team in Slack when a site deploys
- Sync content to a search index or CDN on publish
- Trigger email campaigns when new products are added
Automate Everything
Webhooks let you build reactive workflows without polling. See the full docs for setup guides and payload schemas.