POST request to it whenever a subscribed event occurs — for example when a webinar starts or a registrant signs up.
How it works
- Subscribe — create a subscription with your endpoint URL and the event types you want. Riverside returns a signing secret (shown only once).
- Receive — when a subscribed event happens, Riverside
POSTs a JSON event envelope to your URL, signed with your secret. - Verify — validate the signature and timestamp headers before trusting the payload. See Verifying Signatures.
- Acknowledge — respond with any
2xxstatus promptly. Non-2xxresponses, timeouts, and network errors are retried.
The event envelope
Every delivery — regardless of event type — shares the same outer JSON shape. The event-specific fields live insidedata.
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for this event. Deduplicate on this value — the same event may be delivered more than once. |
event | string | The wire event type, e.g. webinar.started. See Event Types. |
event_ts | integer | Unix timestamp (seconds) of when the event occurred — not when it was delivered. |
account_id | string | The Riverside account the event belongs to. |
data | object | The event-specific public payload. Its shape depends on event — see Event Types. |
delivery_attempt | integer | 1 on the first attempt; increments on each retry. |
Delivery guarantees
- At-least-once. A successful delivery is any
2xxresponse. On failure Riverside retries on a backoff schedule; a single event can therefore be delivered more than once. Always dedupe onid. - Not ordered. Events are not guaranteed to arrive in the order they occurred. Use
event_tsif ordering matters to you. - HTTPS only. Endpoints must be publicly reachable over HTTPS. Redirects are not followed — a
3xxresponse is treated as a failed attempt. - Signed. Every request carries an HMAC signature and timestamp so you can verify authenticity and guard against replay.
Next steps
Event Types
The catalog of events you can subscribe to and their payloads.
Verifying Signatures
Authenticate incoming deliveries.
Delivery & Retries
Retry schedule, auto-disable, and replay.