About the Registration Form API

Site owners can customize a registration form for the site visitor to fill out with their contact details, and other information, as relevant. Default fields are: first name, last name and email. Custom form fields are supported, including free text fields, drop-down lists, and radio buttons, checkboxes, dates, addresses, and phones.

The registration form is made up of controls, each of which may include multiple field inputs (e.g., an address control including inputs for street address, city, state, country and zip code).

Each event has one published form and one draft (by default, each include first name, last name and email). All calls to add, update or delete controls affect the draft form, which can be published at any time with the Publish Draft endpoint.

Was this helpful?
Yes
No

Form Object

Attributes
controlsArray <InputControl>
Nested fields as an ordered list.

messagesobject
Set of configured form messages.
Was this helpful?
Yes
No

GetGet Form

Retrieves an event registration form (both the draft and published versions).

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/events/v1/events/{eventId}/form

Was this helpful?
Yes
No

DeleteDiscard Draft

Clears all changes to the draft form. (Does not affect the published form.)

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/events/v1/events/{eventId}/form

Was this helpful?
Yes
No

PostAdd Control

Adds an input control to the draft form.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v1/events/{eventId}/form/control

Was this helpful?
Yes
No

PutUpdate Control

Updates an existing input control in the draft form.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.
Endpoint
PUT
https://www.wixapis.com/events/v1/events/{eventId}/form/controls/{id}

Was this helpful?
Yes
No

DeleteDelete Control

Deletes an input control from the draft form.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/events/v1/events/{eventId}/form/controls/{id}

Was this helpful?
Yes
No

PatchUpdate Messages

Updates draft form messages, as displayed in the Wix UI before, during, and after the registration flow. Configurable messages include form titles, response labels, "thank you" messages, and call-to-action texts.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{eventId}/form/messages

Was this helpful?
Yes
No

PostPublish Draft

Publishes the draft form. Sets event registration form equal to contents of draft form.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v1/events/{eventId}/form/publish

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Form Event Updated

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
timestampstringformat date-time
Event update timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.

locationobject
Event location.

scheduleConfigobject
Event schedule configuration.

titlestring
Event title.

scheduleConfigUpdatedboolean
Whether schedule configuration was updated.
Was this helpful?
Yes
No