Events
Outbound event envelope and when each event type fires.
Styrar emits outbound events when workspace resources change: links are created or clicked, campaigns start, posts publish, and more. Events are the data inside webhook deliveries.
Plan requirement: Receiving webhook deliveries requires a Team or Agency workspace when you manage endpoints via the API. See Authentication.
Event envelope
Every delivery uses the same top-level JSON shape. Event-specific fields live under data.object:
| Field | Type | Description |
|---|---|---|
id | string | Unique event id (same as Styrar-Event-Id header) |
type | string | Event name (for example link.clicked) |
api_version | string | Payload schema version (2026-06-22) |
created_at | string | ISO 8601 timestamp |
workspace.type | string | company or personal |
workspace.company_id | string | null | Company id when workspace is company-scoped |
data.object | object | Event payload (documented per type) |
Available events
| Event | When it fires |
|---|---|
link.created | A short link is created |
link.updated | A short link is updated |
link.deleted | A short link is soft-deleted |
link.clicked | A tracked click is recorded |
link.experiment.completed | An A/B test completes with a winner |
campaign.created | A campaign is created |
post.published | A post publishes to all platform targets |
webhook.test | You send a test ping from the dashboard or API |
Call GET /v1/webhooks/event-types for the live catalog in your environment.
Guides in this section
| Guide | Description |
|---|---|
| Event types | Full payload reference for every event |
| Webhooks | Register endpoints and receive deliveries |
Webhooks vs REST
| Approach | Best for |
|---|---|
| Webhooks | Real-time reactions (CRM sync, automations, warehouses) |
| REST API | On-demand reads and writes when your system polls or drives the flow |
Many integrations use both: webhooks for push notifications and the REST API for backfills or mutations.
Related
- Event types — per-event payload fields and examples
- Set up a webhook — endpoint configuration
- Verify signatures — validate deliveries