The Participations API lets you manage participation details for events and schedules.
With the Participations API, you can:
participation
objects.participation
objects.participation
objects.For more in-depth event management, see:
It’s important to note the following points before starting to code:
participation
object, the corresponding
events' participants
and remainingCapacity
fields are automatically updated.The following table shows field support for filters for the participation object in Query Participations.
Field | Supported Filters |
---|---|
id | in |
eventId | eq , in |
scheduleId | eq , in |
externalId | eq , in |
To learn about working with Query endpoints in general, see API Query Language.
The response in Query Participations
is always sorted by createdDate
. The default sort order is descending.
Field | Order |
---|---|
createdDate | ASC , DESC |
The participation
object represents the relationship between a participant and
an event
or schedule.
It includes details about the participant, whether the participation status is confirmed or
pending, which app owns the relevant event or schedule, and allows for custom data extensions.
Participation ID.
External ID.
Information about the participant.
Party size of the group or 1
for individuals.
Min: 1
Max: 1000
Status of the party's participation in the event. Depending on your implementation, confirmation may be handled by the business owner or the customer.
Supported values:
CONFIRMED
: The party's participation is confirmed. For example, the business owner has confirmed a booking.PENDING_CONFIRMATION
: The party's participation is awaiting confirmation. For example, the business owner still needs to approve the booking.Default: CONFIRMED
Revision number, which increments by 1 each time the participation is updated. To prevent conflicting changes, the current revision must be passed when updating the participation. Ignored when creating a participation.
Date the participation was created in YYYY-MM-DDThh:mm:ss.sssZ
format.
Date the participation was updated in YYYY-MM-DDThh:mm:ss.sssZ
format.
Extensions enabling applications or users to save custom data related to the participation.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a participation
object.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the participation
object to retrieve.
Retrieved participation
object.
curl -X GET \
'https://www.wixapis.com/calendar/v3/participations/b123e549-eb05-4c6e-8dab-0409c7ebc006' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{
"participation": {
"id": "b123e549-eb05-4c6e-8dab-0409c7ebc006",
"externalId": "c7e4cd82-1d17-49b0-b1df-6e1eaed60a20",
"participant": {
"name": "Jane Doe",
"phone": "55-555-5555",
"email": "jane.doe@example.com",
"contactId": "5f4a86c5-fadf-427e-96e7-d57c14a4f49d"
},
"eventId": "130o4ncdcmm8csGKUihodsF8Lnx5vQuUmP9uqeurIYireDpysq5nOxSIMvXKf80QrOXzc09i1GXRepTUj2L01bzmifAqWHwp2pTmmtR3TmHJx7Tv6ODrmgS",
"partySize": 1,
"status": "CONFIRMED",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"revision": "1",
"createdDate": "2024-10-07T09:14:54.796Z",
"updatedDate": "2024-10-07T09:14:54.796Z"
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a participation
object.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of participation
object to delete.
curl -X DELETE \
'https://www.wixapis.com/calendar/v3/participations/b123e549-eb05-4c6e-8dab-0409c7ebc006' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of participations
, given the provided paging, filtering, and sorting.
Query Participations runs with these defaults, which you can override:
createdDate
is sorted in DESC
ordercursorPaging.limit
is 50
For field support for filters and sorting, see Calendar Participations V3: Supported Filters and Sorting.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
You can only call this method when authenticated as a Wix app or Wix user identity.
Query containing filters and paging.
Retrieved participation
objects matching the provided query.
Paging metadata.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a participation
object for a schedule or event.
You can only call this method when authenticated as a Wix app or Wix user identity.
participation
object to create.
Idempotency key guaranteeing that you don't create the same participation
object more than once.
Created participation
object.
Creates an event participation.
curl -X POST \
'https://www.wixapis.com/calendar/v3/participations' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"participation": {
"eventId": "130o4ncdcmm8csGKUihodsF8Lnx5vQuUmP9uqeurIYireDpysq5nOxSIMvXKf80QrOXzc09i1GXRepTUj2L01bzmifAqWHwp2pTmmtR3TmHJx7Tv6ODrmgS",
"externalId": "c7e4cd82-1d17-49b0-b1df-6e1eaed60a20",
"participant": {
"contactId": "5f4a86c5-fadf-427e-96e7-d57c14a4f49d",
"email": "jane.doe@example.com",
"name": "Jane Doe",
"phone": "55-555-5555"
},
"partySize": 1,
"status": "CONFIRMED"
}
}'
{
"participation": {
"id": "b123e549-eb05-4c6e-8dab-0409c7ebc006",
"externalId": "c7e4cd82-1d17-49b0-b1df-6e1eaed60a20",
"participant": {
"name": "Jane Doe",
"phone": "55-555-5555",
"email": "jane.doe@example.com",
"contactId": "5f4a86c5-fadf-427e-96e7-d57c14a4f49d"
},
"eventId": "130o4ncdcmm8csGKUihodsF8Lnx5vQuUmP9uqeurIYireDpysq5nOxSIMvXKf80QrOXzc09i1GXRepTUj2L01bzmifAqWHwp2pTmmtR3TmHJx7Tv6ODrmgS",
"partySize": 1,
"status": "CONFIRMED",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"revision": "1",
"createdDate": "2024-10-07T09:14:54.796Z",
"updatedDate": "2024-10-07T09:14:54.796Z"
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates a participation
object.
You can only call this method when authenticated as a Wix app or Wix user identity.
Participation ID.
participation
object to update.
Updated participation
object.
Updates a participation's party size.
curl -X PATCH \
'https://www.wixapis.com/calendar/v3/participations/b123e549-eb05-4c6e-8dab-0409c7ebc006' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"participation": {
"partySize": 5,
"revision": "1"
}
}'
{
"participation": {
"id": "b123e549-eb05-4c6e-8dab-0409c7ebc006",
"externalId": "c7e4cd82-1d17-49b0-b1df-6e1eaed60a20",
"participant": {
"name": "Jane Doe",
"phone": "55-555-5555",
"email": "jane.doe@example.com",
"contactId": "5f4a86c5-fadf-427e-96e7-d57c14a4f49d"
},
"eventId": "130o4ncdcmm8csGKUihodsF8Lnx5vQuUmP9uqeurIYireDpysq5nOxSIMvXKf80QrOXzc09i1GXRepTUj2L01bzmifAqWHwp2pTmmtR3TmHJx7Tv6ODrmgS",
"partySize": 5,
"status": "CONFIRMED",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"revision": "2",
"createdDate": "2024-10-07T09:14:54.796Z",
"updatedDate": "2024-10-07T09:17:24.935Z"
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a participation
object is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.calendar.v3.participation
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.calendar.v3.participation_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "9c8e5653-6d37-4bc2-9b28-2ad8ee5efa82",
"entityFqdn": "wix.calendar.v3.participation",
"slug": "created",
"entityId": "b9d81e37-3883-4318-b746-dcf2e6c0fc01",
"createdEvent": {
"entity": {
"id": "b9d81e37-3883-4318-b746-dcf2e6c0fc01",
"externalId": "c7e4cd82-1d17-49b0-b1df-6e1eaed60a20",
"participant": {
"name": "Jane Doe",
"phone": "55-555-5555",
"email": "jane.doe@example.com",
"contactId": "5f4a86c5-fadf-427e-96e7-d57c14a4f49d"
},
"eventId": "130o4ncdcmm8csGKUihodsF8Lnx5vQuUmP9uqeurIYireDpysq5nOxSIMvXKf80QrOXzc09i1GXRepTUj2L01bzmifAqWHwp2pTmmtR3TmHJx7Tv6ODrmgS",
"partySize": 1,
"status": "CONFIRMED",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"revision": "1",
"createdDate": "2024-10-15T11:29:39.013Z",
"updatedDate": "2024-10-15T11:29:39.013Z"
}
},
"eventTime": "2024-10-15T11:29:39.041491431Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "1"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a participation
object is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.calendar.v3.participation
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.calendar.v3.participation_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "8264f9ad-fc9f-4694-b4ad-48dd35b44abc",
"entityFqdn": "wix.calendar.v3.participation",
"slug": "updated",
"entityId": "b9d81e37-3883-4318-b746-dcf2e6c0fc01",
"updatedEvent": {
"currentEntity": {
"id": "b9d81e37-3883-4318-b746-dcf2e6c0fc01",
"externalId": "c7e4cd82-1d17-49b0-b1df-6e1eaed60a20",
"participant": {
"name": "Jane Doe",
"phone": "55-555-5555",
"email": "jane.doe@example.com",
"contactId": "5f4a86c5-fadf-427e-96e7-d57c14a4f49d"
},
"eventId": "130o4ncdcmm8csGKUihodsF8Lnx5vQuUmP9uqeurIYireDpysq5nOxSIMvXKf80QrOXzc09i1GXRepTUj2L01bzmifAqWHwp2pTmmtR3TmHJx7Tv6ODrmgS",
"partySize": 2,
"status": "CONFIRMED",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"revision": "2",
"createdDate": "2024-10-15T11:29:39.013Z",
"updatedDate": "2024-10-15T11:31:57.401Z"
}
},
"eventTime": "2024-10-15T11:31:57.476860938Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "2"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a participation
object is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.calendar.v3.participation
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.calendar.v3.participation_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "1f56a92a-b5ae-4aa1-88dd-4b01353a1679",
"entityFqdn": "wix.calendar.v3.participation",
"slug": "deleted",
"entityId": "b9d81e37-3883-4318-b746-dcf2e6c0fc01",
"deletedEvent": {
"movedToTrash": null,
"deletedEntity": null
},
"eventTime": "2024-10-15T11:33:34.916846821Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "9223372036854775807"
}