GET /api/v1/workspace-webhooks/events. It includes each event’s JSON schema and a sample. This page summarises it.
Fields that have no value are left out of data. IDs are always UUIDs.
Publishing events
Account events carry the account’s
id, name, provider (for example instagram) and status. account.deleted carries id and "deleted": true.
Post events carry the post’s id and a numeric status. Fetch the full post with Get a post.
post.deleted carries ids (a list of post IDs), deleted and to_trash.
Messaging events
Messaging events can be limited to one channel per subscription:whatsapp, facebook, instagram, sms or tiktok, or all.
Contacts
Conversations and messages
Not every channel reports every message status:
You can’t subscribe a channel to a status it never reports.
Automations and broadcasts
Payments and bookings
Store
All store events carryevent, contact and order.
salesbot.store.order_created, salesbot.store.order_paid, salesbot.store.payment_failed, salesbot.store.checkout_abandoned, salesbot.store.order_fulfilled, salesbot.store.order_cancelled, salesbot.store.order_refunded, salesbot.store.product_back_in_stock, salesbot.store.inventory_low, salesbot.store.customer_milestone
Data objects
Text fields are capped at 1,000 characters (
message.text at 10,000) and lists at 100 items. Contact and message events can include personal data such as names, emails, phone numbers and message text, so protect your receiver accordingly.