Webhooks
Webhooks are the primary mechanism for receiving asynchronous, event-driven updates from the ChatWerk platform. They are required for building state-synchronized, production-grade messaging integrations and must be treated as first-class infrastructure components.
Event-Driven Architecture
The ChatWerk API follows an event-driven model for all inbound and state-changing operations.
While REST endpoints are used to initiate actions (e.g. message sends, template creation), webhooks deliver authoritative state transitions back to your system.
Typical webhook-driven state changes include:
- Inbound user messages
- Message lifecycle updates (accepted, sent, delivered, read, failed)
- Template status transitions
- Channel- or account-level configuration events
Polling is neither recommended nor sufficient for correct system behavior.
Available Webhook Scopes
Webhook registrations are scoped by resource and responsibility.
Channel-Level Webhooks
Used for message flow and delivery state tracking.
/core/channels/:channel_id/webhooks
Event categories include:
- Inbound messages
- Message acknowledgements
- Delivery, read, and failure events
- Channel-specific system notifications
Organization-Level Webhooks
Used for template and account-related lifecycle events.
/core/organizations/:organization_id/webhooks
Event categories include:
- Template approval and rejection events
- Template state changes
- Platform or configuration updates
Updated 7 months ago