Registration
EventPoint supports three registration integration patterns. Choose the simplest one that still applies the business rules your workflow needs.
| Use case | Recommended approach |
|---|---|
| Import or maintain known registrants | Use the registrant create, update, and delete operations. |
| Apply event availability, registration types, pass codes, tickets, waitlists, or cancellation rules | Use the event registration lifecycle operations. |
| Present a multi-page experience with conditional questions, purchases, payments, or scheduling | Use an EventPoint registration form. |
Before you begin
Section titled “Before you begin”You need:
- an issued credential and the API base URL described in the quickstart;
- the project and event GUIDs for the registration; and
- a registration type enabled for that event.
Use the Quickstart when your configuration contains codes
instead of GUIDs. You can inspect an event’s configured
registration details with
GET /api/events/{eventid}/registrations
and list the project’s registration types with
GET /api/registration/for-project.
Direct registrant maintenance
Section titled “Direct registrant maintenance”Use direct mutations for administrative synchronization, migration, or another trusted-server workflow where your integration already knows who should be registered.
POST /api/registrantscreates a registrant for an event and registration type.PATCH /api/registrants/{registrantid}changes only the supplied editable fields.DELETE /api/registrants/{registrantid}removes the registrant when the event and registration type in the query match the record.
The create operation requires eventId, registrationTypeId, email, and at
least one usable name value. It creates an incomplete registrant; it does not
represent a finished attendee checkout.
curl --request POST \ --url "$API_URL/api/registrants" \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --header "x-api-key: $API_KEY" \ --data '{ "eventId": "11111111-1111-1111-1111-111111111111", "registrationTypeId": "22222222-2222-2222-2222-222222222222", "email": "alex@example.com", "firstName": "Alex", "lastName": "Rivera" }'Custom registration fields can be supplied through meta. Use the generated
request schema for the current set of standard fields, and use only metadata
fields assigned to the selected registration type.
Event registration lifecycle
Section titled “Event registration lifecycle”Use the event lifecycle when the integration is acting on a configured registration rather than merely maintaining a record.
- Check whether registration is currently available with
GET /api/events/{eventid}/registration-check. - If the flow accepts a code, validate it with
POST /api/events/registration-code-validate. - Start the registration with
POST /api/events/registration-start. Retain the returned registrant and registration-group identifiers. - Complete the configured data collection and commerce steps. In a
forms-based workflow, final form submission completes this part of the flow;
there is no separate public
registration-finishoperation. - Send a confirmation when the workflow requires it with
POST /api/events/registration-send-confirmation. - Cancel an existing registration with
POST /api/events/registration-cancel.
Registration types may also expose pass codes, ticket types, and tickets. Their availability and behavior come from the EventPoint project configuration; do not infer capacity or pricing solely from a registrant record.
Registration forms
Section titled “Registration forms”Choose an EventPoint registration form when the attendee experience includes multiple pages, conditional questions, registration codes, session selection, purchasable items, payment, or several people in one registration group. The form coordinates those steps and maps the submitted answers to EventPoint resources.
Forms are not currently documented as public API endpoints. See Forms for the conceptual workflow, and ask your EventPoint contact for more information if you are interested in using forms.