Event Subscriptions Overview
Subscribe to platform events and receive webhooks when things happen.
PlatformXe emits events when significant actions occur across its services — emails sent, permissions changed, invoices created, and more. Event subscriptions let you receive these events via webhooks in real time.
How it works
- Register a subscription with an event type pattern and a webhook URL
- PlatformXe matches events against your subscription patterns
- Webhooks are delivered with HMAC-SHA256 signatures and retry logic
Event types
PlatformXe emits 40+ events across 13 services. Events follow a consistent naming pattern:
service.entity.action
Examples:
email.message.sentpermissions.role.createdbilling.invoice.paidstorage.file.uploadedwebhook.delivery.failed
Wildcard patterns
Subscriptions support wildcard matching:
| Pattern | Matches |
|---|---|
email.message.sent | Exact match only |
email.message.* | All message events (sent, failed, bounced) |
email.* | All email events |
* | All events |
Quick example
// Subscribe to all permission events
await px.createEventSubscription({
eventType: 'permissions.*',
webhookUrl: 'https://your-app.com/webhooks/platformxe',
secret: 'whsec_your_signing_secret',
});
Start with broad wildcard patterns during development to see all events, then narrow down to specific patterns in production to reduce noise.
Next steps
- Manage Subscriptions — CRUD for subscriptions
- Webhook Delivery — signatures, retries, headers
- Event Catalog — full list of all 40+ events