API Reference
Registrations API
Register viewers for events and manage their registration status.
Create Registration
POST /v1/events/{eventId}/registrations{
"email": "viewer@example.com",
"name": "Jane Doe",
"externalId": "your_user_id_123",
"metadata": {
"plan": "enterprise",
"company": "Acme Corp"
}
}The externalId field links this registration to a user in your system. Include it to simplify webhook processing and analytics correlation.
The metadata field accepts arbitrary key-value pairs that are stored with the registration and included in webhook payloads and analytics exports.
List Registrations
GET /v1/events/{eventId}/registrationsReturns all registrations for an event with pagination.
Get Registration
GET /v1/events/{eventId}/registrations/{registrationId}Returns registration details including cumulative watch time, completion status, and session count.