With the Events API you can create and manage events on your site. This API can be used to create sites for concerts, sport camps, city tours, weddings, and so on.
The Events API allows you to:
These registration types define what type of event they are registering for:
When defining an event, the event must have a date and time. The event can be either single, or recurring:
The event can happen in:
It’s important to note the following points before starting to code:
When defining event registration:
registration.type
of either RSVP
or TICKETING
, which is the same as the registration.initialType
property (this property remains unchanged).registration.external.url
field. After doing this, the registration type becomes EXTERNAL
, and directs guests to the specified external URL for registration. The existing guest list, originally managed by the Events API, still exists but no longer is maintained by the API. Make sure to manage the guest list from the external platform.registration.registrationDisabled
property to true
. After doing this, the registration.type
value becomes NONE
.The following table shows field support for filters and sorting for the Events object:
Field | Query Filter Operators | Sortable |
---|---|---|
id | $eq , $ne , $in , $hasSome | Sortable |
title | $eq , $ne , $lt , $lte , $gt , $gte , $in , $hasSome | Sortable |
slug | $eq , $ne , $lt , $lte , $gt , $gte , $in , $hasSome | Sortable |
updatedDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $hasSome | Sortable |
createdDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $hasSome | Sortable |
status | $eq , $ne , $in , $hasSome | Sortable |
userId | $eq , $ne , $in , $hasSome | Sortable |
registration.initialType | $eq | Not sortable |
dateAndTimeSettings.startDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $hasSome | Sortable |
dateAndTimeSettings.endDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $hasSome | Sortable |
Related content: API Query Language, Events Query endpoint
This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.
This use case demonstrates the automation of event cancellation. For example, when a concert tour is canceled, the Events API allows you to bulk cancel all scheduled concerts simultaneously. Additionally, automated cancellation emails can be sent to notify customers about the tour cancellation, providing essential information and any available alternatives or refunds.
To cancel events and send cancellation emails, follow these steps:
Query Event Guests by eventId
of the events that are going to be cancelled.
Retrieve all the email addresses from the guestDetails
object, and write your code so that the email address can be passed to your marketing tool.
On an ongoing basis, listen for the Event Canceled Webhook.
Bulk Cancel Events by Filter. Specify categoryId
of the recurring events in the filter object to cancel all events.
When the webhook is triggered for your event, send the cancellation email from your marketing tool.
Send timely notifications and important details leading up to the event for your attendees. Organizers can schedule automated reminders to be sent to registered attendees a specific number of days or hours before the event:
These reminders can include event date, time, location, agenda, and any additional instructions or updates. This use case reduces the likelihood of no-shows, and enhances attendee engagement.
To send reminders, follow these steps:
Query Event Guests by eventId
.
Retrieve all the email addresses from the guestDetails
object, and write your code so that the email addresses can be passed to your marketing tool.
On an ongoing basis, listen for Event Reminder Webhook.
When the webhook is triggered for your event, send the reminder email from your marketing tool.
Event ID.
Event location.
Event date and time settings.
Event title.
Short description that appears under the event title.
Note: This field is returned only when the DETAILS
fieldset is included in the request.
Detailed description of an event.
This field is deprecated.
Main event image.
Note: This field is returned only when the DETAILS
fieldset is included in the request.
Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is "Leather Crafting 101", then the slug is "leather-crafting-101".
Date and time when the event was created.
Date and time when the event was updated.
Event status.
RSVP or ticketing registration details.
Note: This field is returned only when the REGISTRATION
fieldset is included in the request.
URLs that allow you to add an event to the Google calendar, or to download an ICS calendar file.
Note: This field is returned only when the DETAILS
fieldset is included in the request.
Event page URL components.
Note: This field is returned only when the URLS
fieldset is included in the request.
Event registration form.
Note: This field is returned only when the FORM
fieldset is included in the request.
Summary of RSVP or ticket sales.
Note: This field is returned only when the DASHBOARD
fieldset is included in the request and you have the "WIX_EVENTS.READ_EVENT_DASHBOARD" permissions.
Instance ID of the site where the event is hosted.
Guest list configuration.
ID of the user who created the event.
Online conferencing details.
Note: This field is returned only when the ONLINE_CONFERENCING_SESSION
fieldset is included in the request and you have the "WIX_EVENTS.READ_ONLINE_CONFERENCING" permissions.
SEO settings.
Note: This field is returned only when the SEO_SETTINGS
fieldset is included in the request.
Assigned contacts label key.
Event schedule details.
Note: This field is returned only when the AGENDA
fieldset is included in the request.
Visual settings for event.
Event description.
This field uses Ricos Document, a structured rich content data format. For a quick start, copy the JSON content from the sample playground below. Learn more about Rich Content (SDK | REST).
emoji
audio
codeBlock
collapsibleList
divider
emoji
file
gallery
giphy
hashtag
heading
html
image
indent
lineSpacing
link
linkPreview
spoiler
video
{
"event": {
"id": "75d64b92-4078-457a-9259-fef2948459f7",
"location": {
"name": "Javits Center",
"type": "VENUE",
"address": {
"country": "US",
"subdivision": "NY",
"city": "New York",
"postalCode": "10001",
"streetAddress": {
"number": "429",
"name": "11th Avenue",
"apt": "",
"formattedAddressLine": null
},
"addressLine2": null,
"formattedAddress": "429 11th Ave, New York, NY 10001, USA",
"hint": null,
"geocode": {
"latitude": 40.7575505,
"longitude": -74.0024691
},
"countryFullname": "United States",
"subdivisions": [
{
"code": "NY",
"name": "New York",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "New York County",
"name": "New York County",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "New York",
"name": "New York",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "US",
"name": "United States",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullName": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-10-15T13:00:00Z",
"endDate": "2023-10-17T22:00:00Z",
"timeZoneId": "America/Toronto",
"hideEndDate": false,
"showTimeZone": true,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "15 October 2023 at 09:00 – 17 October 2023 at 18:00 GMT-4",
"startDate": "15 October 2023",
"startTime": "09:00",
"endDate": "17 October 2023",
"endTime": "18:00"
}
},
"title": "Cosmic Odyssey: Exploring the Mysteries of the Universe",
"shortDescription": "Embark on an extraordinary voyage through the vast expanse of the cosmos!",
"description": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "70zrx108",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Embark on an extraordinary journey beyond the stars at "
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Cosmic Odyssey: Exploring the Mysteries of the Universe",
"decorations": [
{
"type": "ITALIC",
"italicData": true
}
]
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": ". This immersive event brings together renowned astronomers, astrophysicists, and space enthusiasts to delve into the wonders of the cosmos."
}
}
]
},
{
"type": "PARAGRAPH",
"id": "bgewn109"
}
]
},
"mainImage": null,
"slug": "cosmic-odyssey-exploring-the-mysteries-of-the-universe",
"languageCode": "en",
"createdDate": "2023-07-12T10:50:59.287Z",
"updatedDate": "2023-07-12T10:58:58Z",
"status": "UPCOMING",
"registration": {
"type": "TICKETING",
"status": "OPEN_TICKETS",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"stockManagerAppId": null,
"currency": "EUR",
"lowestPrice": {
"value": "20.50",
"currency": "EUR",
"formattedValue": "€20.50"
},
"highestPrice": {
"value": "20.50",
"currency": "EUR",
"formattedValue": "€20.50"
},
"soldOut": false,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "TICKETING",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": {
"google": "http://calendar.google.com/calendar/render?action=TEMPLATE&text=Cosmic+Odyssey%3A+Exploring+the+Mysteries+of+the+Universe&dates=20231015T130000Z%2F20231017T220000Z&location=429+11th+Ave%2C+New+York%2C+NY+10001%2C+USA&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ACosmic+Odyssey%3A+Exploring+the+Mysteries+of+the+Universe%0A15+October+2023+at+09%3A00+%E2%80%93+17+October+2023+at+18%3A00+GMT-4%0AJavits+Center%2C+429+11th+Ave%2C+New+York%2C+NY+10001%2C+USA",
"ics": "https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcIjc1ZDY0YjkyLTQwNzgtNDU3YS05MjU5LWZlZjI5NDg0NTlmN1wifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MTU5NTQyfQ.t2whuT7asvgBxaurkIsVm52Bumpj3L8WQxIMdjVfKLo"
},
"eventPageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/event-details-registration/cosmic-odyssey-exploring-the-mysteries-of-the-universe"
},
"form": {
"controls": [
{
"type": "NAME",
"system": true,
"name": "name",
"inputs": [
{
"name": "firstName",
"array": false,
"label": "First name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
},
{
"name": "lastName",
"array": false,
"label": "Last name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "First name, Last name",
"orderIndex": 0,
"id": "name"
},
{
"type": "INPUT",
"system": true,
"name": "email",
"inputs": [
{
"name": "email",
"array": false,
"label": "Email",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 255,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "Email",
"orderIndex": 1,
"id": "email"
}
],
"messages": {
"rsvp": {
"rsvpYesOption": "I'm Going",
"rsvpNoOption": "Not Going",
"positiveMessages": {
"title": "Add your details",
"confirmation": {
"title": "Thank you!",
"message": "An email with all the event info was sent to you.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"waitlistMessages": {
"title": "Looks like this event is full. Join the waitlist.",
"confirmation": {
"title": "Thanks! You've been added to the waitlist.",
"message": "We'll update you if additional spots become available.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"negativeMessages": {
"title": "Add your details",
"confirmation": {
"title": "Sorry You Can't Make It",
"shareActionLabel": "Share"
}
},
"submitActionLabel": "SUBMIT"
},
"checkout": {
"title": "Add your details",
"submitActionLabel": "Continue"
},
"registrationClosed": {
"message": "Registration is closed",
"exploreEventsActionLabel": "See other events"
},
"ticketsUnavailable": {
"message": "Tickets are not on sale",
"exploreEventsActionLabel": "See other events"
}
}
},
"summaries": null,
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": null,
"onlineConferencing": {
"enabled": false,
"providerId": null,
"providerName": "",
"type": -1,
"session": null
},
"seoSettings": null,
"contactLabel": "custom.cosmic-odyssey-exploring-the-mysteries-of-the-univ",
"agendaSettings": null,
"categories": [
{
"id": "4a69c13e-eb55-47a8-8ccf-9b55198428a0",
"name": "science",
"createdDate": "2023-07-12T10:51:00.029Z",
"hidden": false,
"type": "MANUAL"
}
]
}
}
Creates an event.
The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See Registration Form for more information.
You can create the event as a draft by setting the draft
value to true
. Otherwise, the event is published right away.
The event is automatically set up to send daily summary reports of new guests to your business email.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event data.
Whether to create the event as a draft.
Predefined sets of fields to return.
Created event.
curl -X POST 'https://www.wixapis.com/events/v3/events' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"event": {
"location": {
"name": "Royal Albert Hall",
"type": "VENUE",
"address": {
"country": "GB",
"city": "London",
"streetAddress": {
"number": "SW7",
"name": "Kensington Gore"
}
}
},
"dateAndTimeSettings": {
"dateAndTimeTbd": true,
"dateAndTimeTbdMessage": "The date is yet to be defined. Stay tuned!"
},
"title": "Nature Symphony: A Musical Journey Through Wildlife",
"description": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "70zrx108",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Immerse yourself in the breathtaking beauty of nature through the universal language of music at "
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Nature Symphony: A Musical Journey Through Wildlife",
"decorations": [
{
"type": "ITALIC",
"italicData": true
}
]
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": ". This enchanting event combines the power of live orchestral performances with stunning visual projections of wildlife and natural landscapes from around the world."
}
}
]
},
{
"type": "PARAGRAPH",
"id": "bgewn109"
}
]
},
"languageCode": "en",
"registration": {
"initialType": "TICKETING",
"tickets": {
"ticketLimitPerOrder": "30",
"currency": "GBP",
"taxSettings": {
"type": "INCLUDED_IN_PRICE"
}
}
}
},
"draft": true,
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"]
}'
{
"event": {
"id": "c241e6e2-c951-440d-8b62-52a6ec382140",
"location": {
"name": "Royal Albert Hall",
"type": "VENUE",
"address": {
"country": "GB",
"subdivision": null,
"city": "London",
"postalCode": "SW7 2BL",
"streetAddress": {
"number": "SW7",
"name": "Kensington Gore",
"apt": "",
"formattedAddressLine": null
},
"addressLine_2": null,
"formattedAddress": "Kensington Gore, London SW7, UK",
"hint": null,
"geocode": {
"latitude": 51.5009132,
"longitude": -0.1766086
},
"countryFullname": "United Kingdom",
"subdivisions": [
{
"code": "England",
"name": "England",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "Greater London",
"name": "Greater London",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "GB",
"name": "United Kingdom",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullname": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": true,
"dateAndTimeTbdMessage": "The date is yet to be defined. Stay tuned!",
"startDate": null,
"endDate": null,
"timeZoneId": null,
"hideEndDate": false,
"showTimeZone": false,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "The date is yet to be defined. Stay tuned!",
"startDate": null,
"startTime": null,
"endDate": null,
"endTime": null
}
},
"title": "Nature's Symphony: A Musical Journey Through Wildlife",
"shortDescription": "Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!",
"description": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "70zrx108",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Immerse yourself in the breathtaking beauty of nature through the universal language of music at "
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Nature Symphony: A Musical Journey Through Wildlife",
"decorations": [
{
"type": "ITALIC",
"italicData": true
}
]
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": ". This enchanting event combines the power of live orchestral performances with stunning visual projections of wildlife and natural landscapes from around the world."
}
}
]
},
{
"type": "PARAGRAPH",
"id": "bgewn109"
}
]
},
"mainImage": null,
"slug": "natures-symphony-a-musical-journey-through-wildlife",
"languageCode": "en",
"createdDate": "2023-07-13T12:52:00.911Z",
"updatedDate": "2023-07-13T12:52:01Z",
"status": "DRAFT",
"registration": {
"type": "TICKETING",
"status": "CLOSED_AUTOMATICALLY",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 30,
"stockManagerAppId": null,
"currency": null,
"lowestPrice": null,
"highestPrice": null,
"soldOut": true,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "TICKETING",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": {
"google": "http://calendar.google.com/calendar/render?action=TEMPLATE&text=Nature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife&dates=&location=Kensington+Gore%2C+London+SW7%2C+UK&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ANature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife%0AThe+date+is+yet+to+be+defined.+Stay+tuned%21%0ARoyal+Albert+Hall%2C+Kensington+Gore%2C+London+SW7%2C+UK",
"ics": "https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MjUyNzIzfQ.Q-l9WdXV2goH7WL6rlo7gFO7qlX4pliKd3ZjhGYO3U"
},
"eventPageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/event-details-registration/natures-symphony-a-musical-journey-through-wildlife"
},
"form": {
"controls": [
{
"type": "NAME",
"system": true,
"name": "name",
"inputs": [
{
"name": "firstName",
"array": false,
"label": "First name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
},
{
"name": "lastName",
"array": false,
"label": "Last name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "First name, Last name",
"orderIndex": 0,
"id": "name"
},
{
"type": "INPUT",
"system": true,
"name": "email",
"inputs": [
{
"name": "email",
"array": false,
"label": "Email",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 255,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "Email",
"orderIndex": 1,
"id": "email"
}
],
"messages": {
"rsvp": {
"rsvpYesOption": "I'm Going",
"rsvpNoOption": "Not Going",
"positiveMessages": {
"title": "Add your details",
"confirmation": {
"title": "Thank you!",
"message": "An email with all the event info was sent to you.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"waitlistMessages": {
"title": "Looks like this event is full. Join the waitlist.",
"confirmation": {
"title": "Thanks! You've been added to the waitlist.",
"message": "We'll update you if additional spots become available.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"negativeMessages": {
"title": "Add your details",
"confirmation": {
"title": "Sorry You Can't Make It",
"shareActionLabel": "Share"
}
},
"submitActionLabel": "SUBMIT"
},
"checkout": {
"title": "Add your details",
"submitActionLabel": "Continue"
},
"registrationClosed": {
"message": "Registration is closed",
"exploreEventsActionLabel": "See other events"
},
"ticketsUnavailable": {
"message": "Tickets are not on sale",
"exploreEventsActionLabel": "See other events"
}
}
},
"summaries": {
"rsvps": {
"totalCount": 0,
"yesCount": 0,
"noCount": 0,
"waitlistCount": 0
},
"tickets": {
"ticketsSold": 0,
"revenue": null,
"currencyLocked": false,
"totalOrders": 0,
"totalSales": null
}
},
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"onlineConferencing": {
"session": {
"hostLink": "https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCJjMjQxZTZlMi1jOTUxLTQ0MGQtOGI2Mi01MmE2ZWMzODIxNDBcIn0iLCJpYXQiOjE2ODkyNTI3MjJ9.KNIfA0xW9EWnUx1BAJk4Qoeqc8C2MIkWEtSxPbQw",
"guestLink": "https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSIsImlhdCI6MTY4OTI1MjcyMn0.recFci4CCmWizRuPv6hHJV5j5ig5N-NCTi2GAZtYz-E",
"password": null,
"sessionCreated": null,
"sessionId": null
}
},
"seoSettings": null,
"contactLabel": "custom.natures-symphony-a-musical-journey-through-wildlif",
"agendaSettings": {
"enabled": false,
"pageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/schedule/natures-symphony-a-musical-journey-through-wildlife"
}
},
"categories": []
}
}
There are 2 errors with this status code:
There are 2 errors with this status code:
See the entire list and learn more about Wix errors.
Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
The new event's date is automatically set to 14 days from the original event date.
If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)".
You can change the required entity field values while cloning an event.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Field values to be changed when cloning the event.
Whether to clone the event as a draft.
Predefined sets of fields to return. If both fields
and fieldsets
are sent in the request, the union of both lists is returned.
Cloned event.
curl -X POST 'https://www.wixapis.com/events/v3/events/217b6eed-f580-43e4-974a-6cc0bfa4b58a/clone' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"draft": true,
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"]
}'
{
"event": {
"id": "88e3ccdb-cab7-48e1-85a9-1d4a9430357f",
"location": {
"name": "San Jose Convention Center",
"type": "VENUE",
"address": {
"country": "US",
"subdivision": "CA",
"city": "San Jose",
"postalCode": "95113",
"streetAddress": {
"number": "150",
"name": "West San Carlos Street",
"apt": "",
"formattedAddressLine": null
},
"addressLine2": null,
"formattedAddress": "150 W San Carlos St, San Jose, CA 95113, USA",
"hint": null,
"geocode": {
"latitude": 37.3284838,
"longitude": -121.8881933
},
"countryFullName": "United States",
"subdivisions": [
{
"code": "CA",
"name": "California",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "Santa Clara County",
"name": "Santa Clara County",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "San Jose",
"name": "San Jose",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "Downtown San Jose",
"name": "Downtown San Jose",
"type": "ADMINISTRATIVE_AREA_LEVEL_4",
"typeInfo": null
},
{
"code": "US",
"name": "United States",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullName": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-07-26T16:00:00Z",
"endDate": "2023-07-27T16:00:00Z",
"timeZoneId": "America/Yellowknife",
"hideEndDate": false,
"showTimeZone": false,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "26 July 2023 at 10:00 – 27 July 2023 at 10:00",
"startDate": "26 July 2023",
"startTime": "10:00",
"endDate": "27 July 2023",
"endTime": "10:00"
}
},
"title": "TechXpo 2023: Innovation and Future Trends Unveiled (1)",
"shortDescription": "Step into a world where technology takes center stage, as groundbreaking innovations, cutting-edge gadgets, and revolutionary ideas converge.",
"mainImage": null,
"slug": "techxpo-2023-innovation-and-future-trends-unveiled-1",
"languageCode": "en",
"createdDate": "2023-07-12T11:14:22.410Z",
"updatedDate": "2023-07-12T11:14:22Z",
"status": "UPCOMING",
"registration": {
"type": "RSVP",
"status": "OPEN_RSVP",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"stockManagerAppId": null,
"currency": null,
"lowestPrice": null,
"highestPrice": null,
"soldOut": true,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "RSVP",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": {
"google": "http://calendar.google.com/calendar/render?action=TEMPLATE&text=TechXpo+2023%3A+Innovation+and+Future+Trends+Unveiled+%281%29&dates=20230726T160000Z%2F20230727T160000Z&location=150+W+San+Carlos+St%2C+San+Jose%2C+CA+95113%2C+USA&details=Thank+you+for+registering+to+our+event%21%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+event+details%3A%0A%0ATechXpo+2023%3A+Innovation+and+Future+Trends+Unveiled+%281%29%0A26+July+2023+at+10%3A00+%E2%80%93+27+July+2023+at+10%3A00%0ASan+Jose+Convention+Center%2C+150+W+San+Carlos+St%2C+San+Jose%2C+CA+95113%2C+USA",
"ics": "https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcIjg4ZTNjY2RiLWNhYjctNDhlMS04NWE5LTFkNGE5NDMwMzU3ZlwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MTYwNDYyfQ.ZAYBeFL8zhcdTVpudlXhpgVPxiQRIFzrygFrjNpJuT4"
},
"eventPageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/event-details-registration/techxpo-2023-innovation-and-future-trends-unveiled-1"
},
"form": {
"controls": [
{
"type": "NAME",
"system": true,
"name": "name",
"inputs": [
{
"name": "firstName",
"array": false,
"label": "First name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
},
{
"name": "lastName",
"array": false,
"label": "Last name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "First name, Last name",
"orderIndex": 0,
"id": "name"
},
{
"type": "INPUT",
"system": true,
"name": "email",
"inputs": [
{
"name": "email",
"array": false,
"label": "Email",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 255,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "Email",
"orderIndex": 1,
"id": "email"
}
],
"messages": {
"rsvp": {
"rsvpYesOption": "I'm Going",
"rsvpNoOption": "Not Going",
"positiveMessages": {
"title": "Add your details",
"confirmation": {
"title": "Thank you!",
"message": "An email with all the event info was sent to you.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"waitlistMessages": {
"title": "Looks like this event is full. Join the waitlist.",
"confirmation": {
"title": "Thanks! You've been added to the waitlist.",
"message": "We'll update you if additional spots become available.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"negativeMessages": {
"title": "Add your details",
"confirmation": {
"title": "Sorry You Can't Make It",
"shareActionLabel": "Share"
}
},
"submitActionLabel": "SUBMIT"
},
"checkout": {
"title": "Add your details",
"submitActionLabel": "Continue"
},
"registrationClosed": {
"message": "Registration is closed",
"exploreEventsActionLabel": "See other events"
},
"ticketsUnavailable": {
"message": "Tickets are not on sale",
"exploreEventsActionLabel": "See other events"
}
}
},
"summaries": {
"rsvps": {
"totalCount": 0,
"yesCount": 0,
"noCount": 0,
"waitlistCount": 0
},
"tickets": {
"ticketsSold": 0,
"revenue": null,
"currencyLocked": false,
"totalOrders": 0,
"totalSales": null
}
},
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": null,
"onlineConferencing": {
"enabled": false,
"providerId": null,
"providerName": "",
"type": -1,
"session": {
"hostLink": "https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCI4OGUzY2NkYi1jYWI3LTQ4ZTEtODVhOS0xZDRhOTQzMDM1N2ZcIn0iLCJpYXQiOjE2ODkxNjA0NjJ9.lzgZbpm4MD3GgwYbuBXEWqSY61UlmydphGnAG3Y49DU",
"guestLink": "https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcIjg4ZTNjY2RiLWNhYjctNDhlMS04NWE5LTFkNGE5NDMwMzU3ZlwifSIsImlhdCI6MTY4OTE2MDQ2Mn0.CbP4RCcGaOR-rtd9v12d5piAUElEuRktiLYzlp5VUt0",
"password": null,
"sessionCreated": null,
"sessionId": null
}
},
"seoSettings": null,
"contactLabel": "custom.techxpo-2023-innovation-and-future-trends-unveil-1",
"agendaSettings": {
"enabled": false,
"pageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/schedule/techxpo-2023-innovation-and-future-trends-unveiled-1"
}
},
"categories": []
}
}
Updates an event.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Field values to be changed.
Predefined sets of fields to return. If both fields
and fieldsets
are sent in the request, the union of both lists is returned.
Updated event.
curl -X PATCH 'https://www.wixapis.com/events/v3/events/1a5f4463-e484-4d03-b40f-8783bf3c16fb' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"event": {
"location": {
"name": "Le Cordon Bleu Paris",
"type": "VENUE",
"address": {
"country": "FR",
"city": "Paris",
"postalCode": "75015",
"streetAddress": {
"number": "13-15",
"name": "Quai André Citroën",
},
},
"dateAndTimeSettings": {
"startDate": "2023-10-20T12:00:00Z",
"endDate": "2023-10-22T16:00:00Z",
"timeZoneId": "Europe/Paris",
},
"title": "Culinary Fusion: A Gastronomic Adventure",
"languageCode": "en",
"registration": {
"type": "TICKETING"
}
}
"fieldmask": {
"dateAndTimeSettings.startDate"
},
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"]
}'
{
"event": {
"id": "1a5f4463-e484-4d03-b40f-8783bf3c16fb",
"location": {
"name": "Le Cordon Bleu Paris",
"type": "VENUE",
"address": {
"country": "FR",
"subdivision": null,
"city": "Paris",
"postalCode": "75015",
"streetAddress": {
"number": "13-15",
"name": "Quai André Citroën",
"apt": "",
"formattedAddressLine": null
},
"addressLine_2": null,
"formattedAddress": "13-15 Quai André Citroën, 75015 Paris, France",
"hint": null,
"geocode": {
"latitude": 48.8483013,
"longitude": 2.2810077
},
"countryFullname": "France",
"subdivisions": [
{
"code": "IDF",
"name": "Île-de-France",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "Département de Paris",
"name": "Département de Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "Paris",
"name": "Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "FR",
"name": "France",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullname": null
},
"locationTbd": false
},
"dateAndTime_settings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-10-20T12:00:00Z",
"endDate": "2023-10-22T18:00:00Z",
"timeZoneId": "Europe/Paris",
"hideEndDate": false,
"showTimeZone": false,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "20 October 2023 at 14:00 – 22 October 2023 at 20:00",
"startDate": "20 October 2023",
"startTime": "14:00",
"endDate": "22 October 2023",
"endTime": "20:00"
}
},
"title": "Culinary Fusion: A Gastronomic Adventure",
"shortDescription": "",
"mainImage": null,
"slug": "culinary-fusion-a-gastronomic-adventure",
"languageDode": "en",
"createdDate": "2023-07-12T12:40:56.315Z",
"updatedDate": "2023-07-13T12:27:06Z",
"status": "UPCOMING",
"registration": {
"type": "TICKETING",
"status": "OPEN_TICKETS",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"stockManagerAppId": null,
"currency": "EUR",
"lowestPrice": {
"value": "80.00",
"currency": "EUR",
"formattedValue": "€80"
},
"highestPrice": {
"value": "80.00",
"currency": "EUR",
"formattedValue": "€80"
},
"soldOut": false,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "TICKETING",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": {
"google": "http://calendar.google.com/calendar/render?action=TEMPLATE&text=Culinary+Fusion%3A+A+Gastronomic+Adventure&dates=20231020T120000Z%2F20231022T180000Z&location=13-15+Quai+Andr%C3%A9+Citro%C3%ABn%2C+75015+Paris%2C+France&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ACulinary+Fusion%3A+A+Gastronomic+Adventure%0A20+October+2023+at+14%3A00+%E2%80%93+22+October+2023+at+20%3A00%0ALe+Cordon+Bleu+Paris%2C+13-15+Quai+Andr%C3%A9+Citro%C3%ABn%2C+75015+Paris%2C+France",
"ics": "https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcIjFhNWY0NDYzLWU0ODQtNGQwMy1iNDBmLTg3ODNiZjNjMTZmYlwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MjUxMjI3fQ.BcziROuZWVn52G6tbPQUAJqCeVBq3x7N9r7Hg5eC2-o"
},
"eventPageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/event-details-registration/culinary-fusion-a-gastronomic-adventure"
},
"form": {
"controls": [
{
"type": "NAME",
"system": true,
"name": "name",
"inputs": [
{
"name": "firstName",
"array": false,
"label": "First name",
"additional_labels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
},
{
"name": "lastName",
"array": false,
"label": "Last name",
"additional_labels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "First name, Last name",
"orderIndex": 0,
"id": "name"
},
{
"type": "INPUT",
"system": true,
"name": "email",
"inputs": [
{
"name": "email",
"array": false,
"label": "Email",
"additional_labels": {},
"options": [],
"mandatory": true,
"maxLength": 255,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "Email",
"orderIndex": 1,
"id": "email"
}
],
"messages": {
"rsvp": {
"rsvp_yes_option": "I'm Going",
"rsvp_no_option": "Not Going",
"positive_messages": {
"title": "Add your details",
"confirmation": {
"title": "Thank you!",
"message": "An email with all the event info was sent to you.",
"add_to_calendar_action_label": "Add to Calendar",
"share_action_label": "Share"
}
},
"waitlist_messages": {
"title": "Looks like this event is full. Join the waitlist.",
"confirmation": {
"title": "Thanks! You've been added to the waitlist.",
"message": "We'll update you if additional spots become available.",
"add_to_calendar_action_label": "Add to Calendar",
"share_action_label": "Share"
}
},
"negative_messages": {
"title": "Add your details",
"confirmation": {
"title": "Sorry You Can't Make It",
"share_action_label": "Share"
}
},
"submit_action_label": "SUBMIT"
},
"checkout": {
"title": "Add your details",
"submit_action_label": "Continue"
},
"registration_closed": {
"message": "Registration is closed",
"explore_events_action_label": "See other events"
},
"tickets_unavailable": {
"message": "Tickets are not on sale",
"explore_events_action_label": "See other events"
}
}
},
"summaries": {
"rsvps": {
"total_count": 0,
"yes_count": 0,
"no_count": 0,
"waitlist_count": 0
},
"tickets": {
"tickets_sold": 0,
"revenue": null,
"currency_locked": false,
"total_orders": 0,
"total_sales": null
}
},
"instance_id": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guest_list_settings": {
"displayed_publicly": false
},
"user_id": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": {
"token": "{\"authorizerAppDefId\":\"140603ad-af8d-84a5-2c80-a0f60cb47351\",\"claims\":[\"wix.feed.FeedAccess\",\"wix.comments.CommentsAccess\",\"wix.reactions.ReactionsAccess\"],\"contextId\":\"1a5f4463-e484-4d03-b40f-8783bf3c16fb\",\"contextType\":\"events\"}"
},
"online_conferencing": {
"enabled": false,
"provider_id": null,
"provider_name": "",
"type": -1,
"session": {
"host_link": "https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCIxYTVmNDQ2My1lNDg0LTRkMDMtYjQwZi04NzgzYmYzYzE2ZmJcIn0iLCJpYXQiOjE2ODkyNTEyMjZ9.i2_mMKkGDII7tNoQAlszXFPpxWCOVgwiApra6gJqy74",
"guest_link": "https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcIjFhNWY0NDYzLWU0ODQtNGQwMy1iNDBmLTg3ODNiZjNjMTZmYlwifSIsImlhdCI6MTY4OTI1MTIyNn0.Pa35kTg9001cQPEGQsVaw45_Dcx7ivrgeML2HXQcALg",
"password": null,
"session_created": null,
"session_id": null
}
},
"seo_settings": null,
"contact_label": "custom.culinary-fusion-a-gastronomic-adventure-10-20-23-1",
"agenda_settings": {
"enabled": false,
"page_url": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/schedule/culinary-fusion-a-gastronomic-adventure"
}
},
"categories": [
{
"id": "bd964127-63ff-47e0-92af-8714037de8c9",
"name": "food",
"created_date": "2023-07-12T12:40:57.129Z",
"hidden": false,
"type": "MANUAL"
}
]
}
}
There are 2 errors with this status code:
There are 2 errors with this status code:
See the entire list and learn more about Wix errors.
Publishes a draft event to your live site. Once published, the event's status changes from DRAFT
to UPCOMING
.
It's impossible to revert the DRAFT
status after publishing. The only option is to clone the event, then delete the original one.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Predefined sets of fields to return. If both fields
and fieldsets
are sent in the request, the union of both lists is returned.
Published event.
curl -X POST 'https://www.wixapis.com/events/v3/events/1a5f4463-e484-4d03-b40f-8783bf3c16fb/publish' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"]
}'
{
"event": {
"id": "1a5f4463-e484-4d03-b40f-8783bf3c16fb",
"location": {
"name": "Le Cordon Bleu Paris",
"type": "VENUE",
"address": {
"country": "FR",
"subdivision": null,
"city": "Paris",
"postalCode": "75015",
"streetAddress": {
"number": "13-15",
"name": "Quai André Citroën",
"apt": "",
"formattedAddressLine": null
},
"addressLine2": null,
"formattedAddress": "13-15 Quai André Citroën, 75015 Paris, France",
"hint": null,
"geocode": {
"latitude": 48.84830129999999,
"longitude": 2.2810077
},
"countryFullName": "France",
"subdivisions": [
{
"code": "IDF",
"name": "Île-de-France",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "Département de Paris",
"name": "Département de Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "Paris",
"name": "Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "FR",
"name": "France",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullName": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-10-20T08:00:00Z",
"endDate": "2023-10-22T16:00:00Z",
"timeZoneId": "Europe/Paris",
"hideEndDate": false,
"showTimeZone": true,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "20 October 2023 at 10:00 – 22 October 2023 at 18:00 GMT+2",
"startDate": "20 October 2023",
"startTime": "10:00",
"endDate": "22 October 2023",
"endTime": "18:00"
}
},
"title": "Culinary Fusion: A Gastronomic Adventure",
"shortDescription": "Prepare your taste buds for an extraordinary gastronomic adventure! ",
"mainImage": null,
"slug": "culinary-fusion-a-gastronomic-adventure",
"languageCode": "en",
"createdDate": "2023-07-12T12:40:56.315Z",
"updatedDate": "2023-07-12T12:42:32Z",
"status": "UPCOMING",
"registration": {
"type": "TICKETING",
"status": "OPEN_TICKETS",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"stockManagerAppId": null,
"currency": "EUR",
"lowestPrice": {
"value": "80.00",
"currency": "EUR",
"formattedValue": "€80"
},
"highestPrice": {
"value": "80.00",
"currency": "EUR",
"formattedValue": "€80"
},
"soldOut": false,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "TICKETING",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": {
"google": "http://calendar.google.com/calendar/render?action=TEMPLATE&text=Culinary+Fusion%3A+A+Gastronomic+Adventure&dates=20231020T080000Z%2F20231022T160000Z&location=13-15+Quai+Andr%C3%A9+Citro%C3%ABn%2C+75015+Paris%2C+France&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ACulinary+Fusion%3A+A+Gastronomic+Adventure%0A20+October+2023+at+10%3A00+%E2%80%93+22+October+2023+at+18%3A00+GMT%2B2%0ALe+Cordon+Bleu+Paris%2C+13-15+Quai+Andr%C3%A9+Citro%C3%ABn%2C+75015+Paris%2C+France",
"ics": "https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcIjFhNWY0NDYzLWU0ODQtNGQwMy1iNDBmLTg3ODNiZjNjMTZmYlwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MTY1NzUyfQ.9mhahsL-2ZmCw5eFmm9Tq5v7LrvC9QR5zCDDLXZUlg"
},
"eventPageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/event-details-registration/culinary-fusion-a-gastronomic-adventure"
},
"form": {
"controls": [
{
"type": "NAME",
"system": true,
"name": "name",
"inputs": [
{
"name": "firstName",
"array": false,
"label": "First name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
},
{
"name": "lastName",
"array": false,
"label": "Last name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "First name, Last name",
"orderIndex": 0,
"id": "name"
},
{
"type": "INPUT",
"system": true,
"name": "email",
"inputs": [
{
"name": "email",
"array": false,
"label": "Email",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 255,
"type": "TEXT",
"maxSize": null,
"defaultOptionSelection": null,
"labels": []
}
],
"label": "Email",
"orderIndex": 1,
"id": "email"
}
],
"messages": {
"rsvp": {
"rsvpYesOption": "I'm Going",
"rsvpNoOption": "Not Going",
"positiveMessages": {
"title": "Add your details",
"confirmation": {
"title": "Thank you!",
"message": "An email with all the event info was sent to you.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"waitlistMessages": {
"title": "Looks like this event is full. Join the waitlist.",
"confirmation": {
"title": "Thanks! You've been added to the waitlist.",
"message": "We'll update you if additional spots become available.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"negativeMessages": {
"title": "Add your details",
"confirmation": {
"title": "Sorry You Can't Make It",
"shareActionLabel": "Share"
}
},
"submitActionLabel": "SUBMIT"
},
"checkout": {
"title": "Add your details",
"submitActionLabel": "Continue"
},
"registrationClosed": {
"message": "Registration is closed",
"exploreEventsActionLabel": "See other events"
},
"ticketsUnavailable": {
"message": "Tickets are not on sale",
"exploreEventsActionLabel": "See other events"
}
}
},
"summaries": {
"rsvps": {
"totalCount": 0,
"yesCount": 0,
"noCount": 0,
"waitlistCount": 0
},
"tickets": {
"ticketsSold": 0,
"revenue": null,
"currencyLocked": false,
"totalOrders": 0,
"totalSales": null
}
},
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": null,
"onlineConferencing": {
"enabled": false,
"providerId": null,
"providerName": "",
"type": -1,
"session": {
"hostLink": "https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCIxYTVmNDQ2My1lNDg0LTRkMDMtYjQwZi04NzgzYmYzYzE2ZmJcIn0iLCJpYXQiOjE2ODkxNjU3NTJ9.L25z74oVsP4ecIzfhYbRBlY4cDjUC5oCcH7FIL4vQ",
"guestLink": "https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcIjFhNWY0NDYzLWU0ODQtNGQwMy1iNDBmLTg3ODNiZjNjMTZmYlwifSIsImlhdCI6MTY4OTE2NTc1Mn0.Ss59KwdfawiLLTVE3G0zQqyjCbWMyVStUmVuQ2ic1OQ",
"password": null,
"sessionCreated": null,
"sessionId": null
}
},
"seoSettings": null,
"contactLabel": "custom.culinary-fusion-a-gastronomic-adventure-10-20-23-1",
"agendaSettings": {
"enabled": false,
"pageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/schedule/culinary-fusion-a-gastronomic-adventure"
}
},
"categories": [
{
"id": "bd964127-63ff-47e0-92af-8714037de8c9",
"name": "food",
"createdDate": "2023-07-12T12:40:57.129Z",
"hidden": false,
"type": "MANUAL"
}
]
}
}
There are 2 errors with this status code:
See the entire list and learn more about Wix errors.
Cancels an event.
After cancellation, registration for an event is closed. To reuse the event, clone and publish it again.
If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Predefined sets of fields to return. If both fields
and fieldsets
are sent in the request, the union of both lists is returned.
Canceled event.
curl -X POST 'https://www.wixapis.com/events/v3/events/fc31ba0c-95bc-40d3-a816-70bf85f1e951/cancel' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"]
}'
{
"event": {
"id": "217b6eed-f580-43e4-974a-6cc0bfa4b58a",
"location": {
"name": "San Jose Convention Center",
"type": "VENUE",
"address": {
"country": "US",
"subdivision": "CA",
"city": "San Jose",
"postalCode": "95113",
"streetAddress": {
"number": "150",
"name": "West San Carlos Street",
"apt": "",
"formattedAddressLine": null
},
"addressLine2": null,
"formattedAddress": "150 W San Carlos St, San Jose, CA 95113, USA",
"hint": null,
"geocode": {
"latitude": 37.3284838,
"longitude": -121.8881933
},
"countryFullName": "United States",
"subdivisions": [
{
"code": "CA",
"name": "California",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "Santa Clara County",
"name": "Santa Clara County",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "San Jose",
"name": "San Jose",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "Downtown San Jose",
"name": "Downtown San Jose",
"type": "ADMINISTRATIVE_AREA_LEVEL_4",
"typeInfo": null
},
{
"code": "US",
"name": "United States",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullName": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-11-10T16:00:00Z",
"endDate": "2023-11-13T01:00:00Z",
"timeZoneId": "America/Yellowknife",
"hideEndDate": false,
"showTimeZone": false,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "10 November 2023 at 09:00 – 12 November 2023 at 18:00",
"startDate": "10 November 2023",
"startTime": "09:00",
"endDate": "12 November 2023",
"endTime": "18:00"
}
},
"title": "TechXpo 2023: Innovation and Future Trends Unveiled",
"shortDescription": "",
"mainImage": null,
"slug": "techxpo-2023-innovation-and-future-trends-unveiled",
"languageCode": "en",
"createdDate": "2023-07-12T11:07:35.059Z",
"updatedDate": "2023-07-12T11:12:52Z",
"status": "CANCELED",
"registration": null,
"calendarUrls": null,
"eventPageUrl": null,
"form": null,
"summaries": null,
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": null,
"onlineConferencing": {
"enabled": false,
"providerId": null,
"providerName": "",
"type": -1,
"session": null
},
"seoSettings": null,
"contactLabel": "custom.techxpo-2023-innovation-and-future-trends-unveiled",
"agendaSettings": null,
"categories": []
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Cancels multiple events that meet the given criteria.
After cancellation, registration for an event is closed. To reuse the event, clone and publish it again.
If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
You can only call this method when authenticated as a Wix app or Wix user identity.
Filter. See supported fields and operators.
curl -X POST 'https://www.wixapis.com/events/v3/bulk/events/cancel-by-filter' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
"filter": {
"categoryId": "eebe3ed6-ffef-46e4-a83a-e883d7ad8fdd"
}
}'
{}
Retrieves an event by ID.
Event ID.
Predefined sets of fields to return.
Event.
curl -X GET 'https://www.wixapis.com/events/v3/events/75d64b92-4078-457a-9259-fef2948459f7?fieldset=REGISTRATION&fieldset=CATEGORIES' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"]
}'
{
"event": {
"id": "75d64b92-4078-457a-9259-fef2948459f7",
"location": {
"name": "Javits Center",
"type": "VENUE",
"address": {
"country": "US",
"subdivision": "NY",
"city": "New York",
"postalCode": "10001",
"streetAddress": {
"number": "429",
"name": "11th Avenue",
"apt": "",
"formattedAddressLine": null
},
"addressLine_2": null,
"formattedAddress": "429 11th Ave, New York, NY 10001, USA",
"hint": null,
"geocode": {
"latitude": 40.7575505,
"longitude": -74.0024691
},
"countryFullName": "United States",
"subdivisions": [
{
"code": "NY",
"name": "New York",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "New York County",
"name": "New York County",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "New York",
"name": "New York",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "US",
"name": "United States",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullName": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-10-15T13:00:00Z",
"endDate": "2023-10-17T22:00:00Z",
"timeZoneId": "America/Toronto",
"hideEndDate": false,
"showTimeZone": true,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "15 October 2023 at 09:00 – 17 October 2023 at 18:00 GMT-4",
"startDate": "15 October 2023",
"startTime": "09:00",
"endDate": "17 October 2023",
"endTime": "18:00"
}
},
"title": "Cosmic Odyssey: Exploring the Mysteries of the Universe",
"shortDescription": "",
"mainImage": null,
"slug": "cosmic-odyssey-exploring-the-mysteries-of-the-universe",
"languageCode": "en",
"createdDate": "2023-07-12T10:50:59.287Z",
"updatedDate": "2023-07-12T10:58:58Z",
"status": "UPCOMING",
"registration": {
"type": "TICKETING",
"status": "OPEN_TICKETS",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"stockManagerAppId": null,
"currency": "EUR",
"lowestPrice": {
"value": "20.50",
"currency": "EUR",
"formattedValue": "€20.50"
},
"highestPrice": {
"value": "20.50",
"currency": "EUR",
"formattedValue": "€20.50"
},
"soldOut": false,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "TICKETING",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": null,
"eventPageUrl": null,
"form": null,
"summaries": null,
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"onlineConferencing": {
"session": null
},
"seoSettings": null,
"contactLabel": "custom.cosmic-odyssey-exploring-the-mysteries-of-the-univ",
"agendaSettings": null,
"categories": [
{
"id": "4a69c13e-eb55-47a8-8ccf-9b55198428a0",
"name": "science",
"createdDate": "2023-07-12T10:51:00.029Z",
"hidden": false,
"type": "MANUAL"
}
]
}
}
Permanently deletes an event.
You can retrieve the deleted event through a GDPR access request.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Deleted event ID.
curl -X DELETE 'https://www.wixapis.com/events/v3/events/55b22d98-643a-4ecd-9a30-3bd01d83c025' \
-H 'Authorization: <AUTH TOKEN>' \
{
"eventId": "55b22d98-643a-4ecd-9a30-3bd01d83c025"
}
Permanently deletes multiple events that meet the given criteria.
You can retrieve the deleted events through a GDPR access request.
You can only call this method when authenticated as a Wix app or Wix user identity.
Query options. See API Query Language for more details.
curl -X POST 'https://www.wixapis.com/events/v3/bulk/events/delete-by-filter' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
"filter": {
"status": "CANCELED"
}
}'
{}
Retrieves a list of events, given the provided paging, filtering, and sorting. Query Events runs with these defaults, which you can override:
createdDate
is sorted in ASC
orderpaging.limit
is 0
paging.offset
is 0
For field support for filters and sorting, see Events v3: Supported Filters and Sorting.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
Note: You need to pass the paging
field in the request to get the items in the response.
Query options. See API Query Language for more details.
Predefined sets of fields to return.
Whether draft events should be returned in the response.
Note: This parameter requires the WIX_EVENTS.READ_DRAFT_EVENTS
permission.
Metadata for the paginated results.
List of events.
curl -X POST 'https://www.wixapis.com/events/v3/events/query' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"query": {
"filter": {
"status": {
"$ne": "CANCELED"
}
},
"paging": {
"limit": 2
}
},
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"],
"includeDrafts": false
}'
{
"pagingMetadata": {
"count": 2,
"offset": 0,
"total": 10,
"tooManyToCount": null,
"cursors": null,
"hasNext": null
},
"events": [
{
"id": "1a5f4463-e484-4d03-b40f-8783bf3c16fb",
"location": {
"name": "Le Cordon Bleu Paris",
"type": "VENUE",
"address": {
"country": "FR",
"subdivision": null,
"city": "Paris",
"postalCode": "75015",
"streetAddress": {
"number": "13-15",
"name": "Quai André Citroën",
"apt": "",
"formattedAddressLine": null
},
"addressLine2": null,
"formattedAddress": "13-15 Quai André Citroën, 75015 Paris, France",
"hint": null,
"geocode": {
"latitude": 48.84830129999999,
"longitude": 2.2810077
},
"countryFullname": "France",
"subdivisions": [
{
"code": "IDF",
"name": "Île-de-France",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "Département de Paris",
"name": "Département de Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "Paris",
"name": "Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "FR",
"name": "France",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullname": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-10-20T08:00:00Z",
"endDate": "2023-10-22T16:00:00Z",
"timeZoneId": "Europe/Paris",
"hideEndDate": false,
"showTimeZone": true,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "20 October 2023 at 10:00 – 22 October 2023 at 18:00 GMT+2",
"startDate": "20 October 2023",
"startTime": "10:00",
"endDate": "22 October 2023",
"endTime": "18:00"
}
},
"title": "Culinary Fusion: A Gastronomic Adventure",
"shortDescription": "",
"mainImage": null,
"slug": "culinary-fusion-a-gastronomic-adventure",
"languageCode": "en",
"createdDate": "2023-07-12T12:40:56.315Z",
"updatedDate": "2023-07-12T12:42:32Z",
"status": "UPCOMING",
"registration": {
"type": "TICKETING",
"status": "OPEN_TICKETS",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"stockManagerAppId": null,
"currency": "EUR",
"lowestPrice": {
"value": "80.00",
"currency": "EUR",
"formattedValue": "€80"
},
"highestPrice": {
"value": "80.00",
"currency": "EUR",
"formattedValue": "€80"
},
"soldOut": false,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "TICKETING",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": null,
"eventPageUrl": null,
"form": null,
"summaries": null,
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": null,
"onlineConferencing": {
"enabled": false,
"providerId": null,
"providerName": "",
"type": -1,
"session": null
},
"seoSettings": null,
"contactLabel": "custom.culinary-fusion-a-gastronomic-adventure-10-20-23-1",
"agendaSettings": null,
"categories": []
},
{
"id": "88e3ccdb-cab7-48e1-85a9-1d4a9430357f",
"location": {
"name": "San Jose Convention Center",
"type": "VENUE",
"address": {
"country": "US",
"subdivision": "CA",
"city": "San Jose",
"postalCode": "95113",
"streetAddress": {
"number": "150",
"name": "West San Carlos Street",
"apt": "",
"formattedAddressLine": null
},
"addressLine_2": null,
"formattedAddress": "150 W San Carlos St, San Jose, CA 95113, USA",
"hint": null,
"geocode": {
"latitude": 37.3284838,
"longitude": -121.8881933
},
"countryFullName": "United States",
"subdivisions": [
{
"code": "CA",
"name": "California",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "Santa Clara County",
"name": "Santa Clara County",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "San Jose",
"name": "San Jose",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "Downtown San Jose",
"name": "Downtown San Jose",
"type": "ADMINISTRATIVE_AREA_LEVEL_4",
"typeInfo": null
},
{
"code": "US",
"name": "United States",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullname": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-07-26T16:00:00Z",
"endDate": "2023-07-27T16:00:00Z",
"timeZoneId": "America/Yellowknife",
"hideEndDate": false,
"showTimeZone": false,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "26 July 2023 at 10:00 – 27 July 2023 at 10:00",
"startDate": "26 July 2023",
"startTime": "10:00",
"endDate": "27 July 2023",
"endTime": "10:00"
}
},
"title": "TechXpo 2023: Innovation and Future Trends Unveiled (1)",
"shortDescription": "",
"mainImage": null,
"slug": "techxpo-2023-innovation-and-future-trends-unveiled-1",
"languageCode": "en",
"createdDate": "2023-07-12T11:14:22.410Z",
"updatedDate": "2023-07-12T11:14:22Z",
"status": "UPCOMING",
"registration": {
"type": "RSVP",
"status": "OPEN_RSVP",
"rsvp": {
"responseType": "YES_ONLY",
"limit": null,
"waitlistEnabled": false,
"startDate": null,
"endDate": null
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"stockManagerAppId": null,
"currency": null,
"lowestPrice": null,
"highestPrice": null,
"soldOut": true,
"taxSettings": null
},
"external": null,
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "RSVP",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": null,
"eventPageUrl": null,
"form": null,
"summaries": null,
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": null,
"onlineConferencing": {
"enabled": false,
"providerId": null,
"providerName": "",
"type": -1,
"session": null
},
"seoSettings": null,
"contactLabel": "custom.techxpo-2023-innovation-and-future-trends-unveil-1",
"agendaSettings": null,
"categories": []
}
],
"facets": {}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Counts events by status. To learn about working with query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
Filter object in the following format:
"filter" : { "fieldName1": "value1" }
.
Parameters to count events by.
Whether draft events should be returned in the response.
Note: This parameter requires the WIX_EVENTS.READ_DRAFT_EVENTS
permission.
Metadata for the paginated results.
Filter facets.
curl -X POST 'https://www.wixapis.com/events/v3/events/count-by-status' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"query": {
"filter": {
"status": {
"$eq": "CANCELED"
}
},
"paging": {
"limit": 10
}
},
"facet": ["status"],
"includeDrafts": false
}'
{
"pagingMetadata": {
"count": 10,
"offset": 0,
"total": 10,
"tooManyToCount": null,
"cursors": null,
"hasNext": null
},
"facets": {
"status": {
"counts": {
"CANCELED": 10
}
}
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Retrieves an event by the slug URL.
URL slug.
Event.
curl -X GET 'https://www.wixapis.com/events/v3/events/slug/cosmic-odyssey-exploring-the-mysteries-of-the-universe' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"]
}'
{
"event": {
"id": "75d64b92-4078-457a-9259-fef2948459f7",
"location": {
"name": "Javits Center",
"type": "VENUE",
"address": {
"country": "US",
"subdivision": "NY",
"city": "New York",
"postalCode": "10001",
"streetAddress": {
"number": "429",
"name": "11th Avenue",
"apt": "",
"formattedAddressLine": null
},
"addressLine2": null,
"formattedAddress": "429 11th Ave, New York, NY 10001, USA",
"hint": null,
"geocode": {
"latitude": 40.7575505,
"longitude": -74.0024691
},
"countryFullName": "United States",
"subdivisions": [
{
"code": "NY",
"name": "New York",
"type": "ADMINISTRATIVE_AREA_LEVEL_1",
"typeInfo": null
},
{
"code": "New York County",
"name": "New York County",
"type": "ADMINISTRATIVE_AREA_LEVEL_2",
"typeInfo": null
},
{
"code": "New York",
"name": "New York",
"type": "ADMINISTRATIVE_AREA_LEVEL_3",
"typeInfo": null
},
{
"code": "US",
"name": "United States",
"type": "COUNTRY",
"typeInfo": null
}
],
"subdivisionFullName": null
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"dateAndTimeTbdMessage": null,
"startDate": "2023-10-15T13:00:00Z",
"endDate": "2023-10-17T22:00:00Z",
"timeZoneId": "America/Toronto",
"hideEndDate": false,
"showTimeZone": true,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": [],
"categoryId": null
},
"formatted": {
"dateAndTime": "15 October 2023 at 09:00 – 17 October 2023 at 18:00 GMT-4",
"startDate": "15 October 2023",
"startTime": "09:00",
"endDate": "17 October 2023",
"endTime": "18:00"
}
},
"title": "Cosmic Odyssey: Exploring the Mysteries of the Universe",
"shortDescription": "",
"mainImage": null,
"slug": "cosmic-odyssey-exploring-the-mysteries-of-the-universe",
"languageCode": "en",
"createdDate": "2023-07-12T10:50:59.287Z",
"updatedDate": "2023-07-12T10:58:58Z",
"status": "UPCOMING",
"registration": null,
"calendarUrls": null,
"eventPageUrl": null,
"form": null,
"summaries": null,
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": null,
"onlineConferencing": {
"enabled": false,
"providerId": null,
"providerName": "",
"type": -1,
"session": null
},
"seoSettings": null,
"contactLabel": "custom.cosmic-odyssey-exploring-the-mysteries-of-the-univ",
"agendaSettings": null,
"categories": []
}
}
Triggered when event is canceled.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
Event name. Expected canceled
.
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.events.v3.event_canceled",
"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": "b8220f32-fc8e-4fe8-93a6-06f2b7f3b0c4",
"entityFqdn": "wix.events.events.v3.event",
"slug": "event_canceled",
"entityId": "88e3ccdb-cab7-48e1-85a9-1d4a9430357f",
"actionEvent": {
"bodyAsJson": {
"timestamp": "2023-07-13T10:14:10.947Z",
"eventId": "88e3ccdb-cab7-48e1-85a9-1d4a9430357f",
"title": "TechXpo 2023: Innovation and Future Trends Unveiled (1)",
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605"
}
},
"eventTime": "2023-07-13T10:14:11.304144Z",
"triggeredByAnonymizeRequest": false
}
Triggered when event is cloned.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
Event name. Expected cloned
.
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.events.v3.event_cloned",
"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": "e9468cd6-e228-49cc-9d87-64171fa14013",
"entityFqdn": "wix.events.events.v3.event",
"slug": "event_cloned",
"entityId": "e55d5214-a5db-4a82-9b80-e06c9a9806d9",
"actionEvent": {
"bodyAsJson": {
"timestamp": "2023-07-11T10:26:40.536Z",
"eventId": "e55d5214-a5db-4a82-9b80-e06c9a9806d9",
"location": {
"name": "Austin",
"type": "VENUE",
"address": {
"country": "US",
"subdivision": "TX",
"city": "Austin",
"streetAddress": {
"number": " ",
"name": " ",
"apt": " "
},
"formattedAddress": "Austin, TX, USA",
"geocode": {
"latitude ": 30.267153,
"longitude ": -97.7430608
},
"countryFullname": "United States",
"subdivisions": [
{
"code": "TX",
"name": "Texas",
"type": "ADMINISTRATIVE_AREA_LEVEL_1"
},
{
"code": "Austin",
"name": "Austin",
"type": "ADMINISTRATIVE_AREA_LEVEL_3"
},
{
"code": "US",
"name": "United States",
"type": "COUNTRY"
}
]
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"startDate": "2035-11-15T00:00:00Z",
"endDate": "2035-11-15T04:00:00Z",
"timeZoneId": "America/New_York",
"hideEndDate": true,
"showTimeZone": false,
"recurrenceStatus": "ONE_TIME",
"recurringEvents": {
"individualEventDates": []
}
},
"title": "Austin",
"userId": "fa66d842-5a20-41c6-acf9-b5c3cd803d46",
"status": "UPCOMING",
"derivedFromInstanceId": "af41da2a-7dbd-49ce-b40a-f59207f5658f",
"derivedFromEventId": "e55d5214-a5db-4a82-9b80-e06c9a9806d9",
"ticketDefinitions": {}
}
},
"eventTime": "2023-07-11T10:26:41.651943Z",
"triggeredByAnonymizeRequest": false
}
Triggered when event is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
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.events.v3.event_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": "01989a45-eff0-4c17-8039-869890743a64",
"entityFqdn": "wix.events.events.v3.event",
"slug": "created",
"entityId": "c4025083-05c3-4ec7-b517-5af1079856e3",
"createdEvent": {
"entityAsJson": {
"id": "c4025083-05c3-4ec7-b517-5af1079856e3",
"location": {
"name": "Esalen Institute",
"type": "VENUE",
"locationTbd": true
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"startDate": "2023-10-28T16:00:00Z",
"endDate": "2023-10-30T23:00:00Z",
"timeZoneId": "America/Yellowknife",
"hideEndDate": false,
"showTimeZone": false,
"recurrenceStatus": "RECURRING",
"recurringEvents": {
"individualEventDates": [],
"categoryId": "eebe3ed6-ffef-46e4-a83a-e883d7ad8fdd"
},
"formatted": {
"dateAndTime": "28 October 2023 at 10:00 – 30 October 2023 at 17:00",
"startDate": "28 October 2023",
"startTime": "10:00",
"endDate": "30 October 2023",
"endTime": "17:00"
}
},
"title": "Mindful Living Retreat: Nurturing Wellness and Inner Peace",
"shortDescription": "Escape to a haven of tranquility and embark on a transformative journey of self-discovery.",
"slug": "mindful-living-retreat-nurturing-wellness-and-inner-peace-2023-10-28-10-00",
"languageCode": "en",
"createdDate": "2023-07-13T13:42:11.400Z",
"updatedDate": "2023-07-13T13:42:13Z",
"status": "UPCOMING",
"registration": {
"type": "RSVP",
"status": "OPEN_RSVP",
"rsvp": {
"responseType": "YES_AND_NO",
"waitlistEnabled": false
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"soldOut": true
},
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "RSVP",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": {
"google": "http: calendar.google.com/calendar/render?action=TEMPLATE&text=Mindful+Living+Retreat%3A+Nurturing+Wellness+and+Inner+Peace&dates=20231028T160000Z%2F20231030T230000Z&location=&details=Thank+you+for+registering+to+our+event%21%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+event+details%3A%0A%0AMindful+Living+Retreat%3A+Nurturing+Wellness+and+Inner+Peace%0A28+October+2023+at+10%3A00+%E2%80%93+30+October+2023+at+17%3A00%0AEsalen+Institute",
"ics": "https: www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImM0MDI1MDgzLTA1YzMtNGVjNy1iNTE3LTVhZjEwNzk4NTZlM1wifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MjU1NzM0fQ.XtMcxbu77COuZDcOM_wy5k-FK6eSuLRNpvTsXDoEqIs"
},
"eventPageUrl": {
"base": "https: ievak9.wixsite.com/accessories",
"path": "/event-details-registration/mindful-living-retreat-nurturing-wellness-and-inner-peace-2023-10-28-10-00"
},
"form": {
"controls": [
{
"type": "NAME",
"system": true,
"name": "name",
"inputs": [
{
"name": "firstName",
"array": false,
"label": "First name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"labels": []
},
{
"name": "lastName",
"array": false,
"label": "Last name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"labels": []
}
],
"label": "First name, Last name",
"orderIndex": 0,
"id": "name"
},
{
"type": "INPUT",
"system": true,
"name": "email",
"inputs": [
{
"name": "email",
"array": false,
"label": "Email",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 255,
"type": "TEXT",
"labels": []
}
],
"label": "Email",
"orderIndex": 1,
"id": "email"
}
],
"messages": {
"rsvp": {
"rsvpYesOption": "I'm Going",
"rsvpNoOption": "Not Going",
"positiveMessages": {
"title": "Add your details",
"confirmation": {
"title": "Thank you!",
"message": "An email with all the event info was sent to you.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"waitlistMessages": {
"title": "Looks like this event is full. Join the waitlist.",
"confirmation": {
"title": "Thanks! You've been added to the waitlist.",
"message": "We'll update you if additional spots become available.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"negativeMessages": {
"title": "Add your details",
"confirmation": {
"title": "Sorry You Can't Make It",
"shareActionLabel": "Share"
}
},
"submitActionLabel": "SUBMIT"
},
"checkout": {
"title": "Add your details",
"submitActionLabel": "Continue"
},
"registrationClosed": {
"message": "Registration is closed",
"exploreEventsActionLabel": "See other events"
},
"ticketsUnavailable": {
"message": "Tickets are not on sale",
"exploreEventsActionLabel": "See other events"
}
}
},
"summaries": {
"rsvps": {
"totalCount": 0,
"yesCount": 0,
"noCount": 0,
"waitlistCount": 0
},
"tickets": {
"ticketsSold": 0,
"currencyLocked": false,
"totalOrders": 0
}
},
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": true
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": {
"token": {
"authorizerAppDefId": "140603ad-af8d-84a5-2c80-a0f60cb47351",
"claims": [
"wix.feed.FeedAccess",
"wix.comments.CommentsAccess",
"wix.reactions.ReactionsAccess"
],
"contextId": "c4025083-05c3-4ec7-b517-5af1079856e3",
"contextType": "events"
}
},
"onlineConferencing": {
"enabled": false,
"providerName": "",
"type": "UNKNOWN_ENUM_VALUE_Type_-1",
"session": {
"hostLink": "https: www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCJjNDAyNTA4My0wNWMzLTRlYzctYjUxNy01YWYxMDc5ODU2ZTNcIn0iLCJpYXQiOjE2ODkyNTU3MzR9.bMFKS98SKvxPfiRKdxPb9caYUiqL1DapIuPB7UlDxsc",
"guestLink": "https: www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcImM0MDI1MDgzLTA1YzMtNGVjNy1iNTE3LTVhZjEwNzk4NTZlM1wifSIsImlhdCI6MTY4OTI1NTczNH0.nWU8HH5h1gBHSMdMOTtd0nxQ70Ja7tBeXIhLjGfrnOc"
}
},
"contactLabel": "custom.mindful-living-retreat-nurturing-wellness-and-inne",
"agendaSettings": {
"enabled": false,
"pageUrl": {
"base": "https: ievak9.wixsite.com/accessories",
"path": "/schedule/mindful-living-retreat-nurturing-wellness-and-inner-peace-2023-10-28-10-00"
}
},
"categories": [
{
"id": "eebe3ed6-ffef-46e4-a83a-e883d7ad8fdd",
"name": "Mindful Living Retreat: Nurturing Wellness and ...",
"createdDate": "2023-07-13T13:42:12.833Z",
"hidden": true,
"type": "RECURRING_EVENT"
}
]
}
},
"eventTime": "2023-07-13T13:42:14.619234Z",
"triggeredByAnonymizeRequest": false
}
Triggered when event is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
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.events.v3.event_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": "d4ed376f-86d7-452a-8a15-55b598d1251f",
"entityFqdn": "wix.events.events.v3.event",
"slug": "deleted",
"entityId": "88e3ccdb-cab7-48e1-85a9-1d4a9430357f",
"deletedEvent": {},
"eventTime": "2023-07-13T10:20:52.440981Z",
"triggeredByAnonymizeRequest": false
}
Triggered when event has ended.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
Event name. Expected ended
.
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.events.v3.event_ended",
"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": "6d430e4e-994c-4eaa-8dec-1d47bf1e46c4",
"entityFqdn": "wix.events.events.v3.event",
"slug": "event_ended",
"entityId": "c8f87dc2-d6c5-4459-8a51-e272512e687d",
"actionEvent": {
"bodyAsJson": {
"timestamp": "2023-07-12T10:00:00Z",
"eventId": "c8f87dc2-d6c5-4459-8a51-e272512e687d"
}
},
"eventTime": "2023-07-12T10:00:15.657475Z",
"triggeredByAnonymizeRequest": false
}
Triggered when event is published.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
Event name. Expected published
.
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.events.v3.event_published",
"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": "0a1d9a4f-0586-49eb-84c2-dfecc82eabf2",
"entityFqdn": "wix.events.events.v3.event",
"slug": "event_published",
"entityId": "178ef33c-d1db-4ed7-916e-e11455067755",
"actionEvent": {
"bodyAsJson": {
"timestamp": "2023-07-13T09:40:00Z",
"eventId ": "178ef33c-d1db-4ed7-916e-e11455067755",
"status": "STARTED",
"derivedFromEventId": "178ef33c-d1db-4ed7-916e-e11455067755"
}
},
"eventTime": "2023-07-13T09:40:02.043090Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a certain amount of time is left until the event. In total there are 6 reminders:
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
Event name. Expected reminder
.
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.events.v3.event_reminder",
"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": "d1c94e6d-b715-407d-933b-a3b563886753",
"entityFqdn": "wix.events.events.v3.event",
"slug": "event_reminder",
"entityId": "117e43e2-8979-43e4-ac60-4c8c9a1c1e19",
"actionEvent": {
"bodyAsJson": {
"timestamp": "2023-07-12T10:00:06.146Z",
"eventId": "117e43e2-8979-43e4-ac60-4c8c9a1c1e19",
"location": {
"name": "Ciné-parc Essence",
"type": "VENUE",
"address": {
"country": "FR",
"city": "Paris",
"postalCode": "75020",
"streetAddress": {
"number": "47",
"name": "Rue des Couronnes",
"apt": ""
},
"formattedAddress": "47 Rue des Couronnes, 75020 Paris, France",
"geocode": {
"latitude": 48.8710678,
"longitude": 2.3847051
},
"countryFullname": "France",
"subdivisions": [
{
"code": "IDF",
"name": "Île-de-France",
"type": "ADMINISTRATIVE_AREA_LEVEL_1"
},
{
"code": "Département de Paris",
"name": "Département de Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_2"
},
{
"code": "Paris",
"name": "Paris",
"type": "ADMINISTRATIVE_AREA_LEVEL_3"
},
{
"code": "FR",
"name": "France",
"type": "COUNTRY"
}
]
},
"locationTbd": false
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"startDate": "2023-07-15T10:00:00Z ",
"endDate": "2023-07-16T10:00:00Z ",
"timeZoneId": "Europe/Paris ",
"hideEndDate": true,
"showTimeZone": false,
"recurrenceStatus": "ONE_TIME ",
"recurringEvents": {
"individualEventDates": []
}
},
"title": "Paper Camp - Séance 12 h",
"userId": "ff9e8230-5019-42c3-adb8-8d7ccb6aab24",
"startsIn": {
"days": 3,
"hours": 0,
"minutes": 0
}
}
},
"eventTime": "2023-07-12T10:00:15.451999Z",
"triggeredByAnonymizeRequest": false
}
Triggered when event has started.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
Event name. Expected started
.
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.events.v3.event_started",
"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": "b742606b-102b-4e9a-9d7a-b365b22a7101",
"entityFqdn": "wix.events.events.v3.event",
"slug": "event_started",
"entityId": "15b75410-b055-45b6-adb6-8bcfab5020c4",
"actionEvent": {
"bodyAsJson": {
"timestamp": "2023-07-12T10:00:00Z",
"eventId": "15b75410-b055-45b6-adb6-8bcfab5020c4"
}
},
"eventTime": "2023-07-12T10:00:15.542960Z",
"triggeredByAnonymizeRequest": false
}
Triggered when event is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.event
.
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.events.v3.event_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": "0ab422ca-5894-49c8-8874-c29e0cb18d4d",
"entityFqdn": "wix.events.events.v3.event",
"slug": "updated",
"entityId": "c4025083-05c3-4ec7-b517-5af1079856e3",
"updatedEvent": {
"currentEntityAsJson": {
"id": "c4025083-05c3-4ec7-b517-5af1079856e3",
"location": {
"name": "Esalen Institute",
"type": "VENUE",
"locationTbd": true
},
"dateAndTimeSettings": {
"dateAndTimeTbd": false,
"startDate": "2023-10-28T18:00:00Z",
"endDate": "2023-10-30T23:00:00Z",
"timeZoneId": "America/Yellowknife",
"hideEndDate": false,
"showTimeZone": false,
"recurrenceStatus": "RECURRING_UPCOMING",
"recurringEvents": {
"individualEventDates": [],
"categoryId": "eebe3ed6-ffef-46e4-a83a-e883d7ad8fdd"
},
"formatted": {
"dateAndTime": "28 October 2023 at 12:00 – 30 October 2023 at 17:00",
"startDate": "28 October 2023",
"startTime": "12:00",
"endDate": "30 October 2023",
"endTime": "17:00"
}
},
"title": "Mindful Living Retreat: Nurturing Wellness and Inner Peace",
"shortDescription": "",
"slug": "mindful-living-retreat-nurturing-wellness-and-inner-peace-2023-10-28-12-00",
"languageCode": "en",
"createdDate": "2023-07-13T13:42:11.400Z",
"updatedDate": "2023-07-14T09:27:57Z",
"status": "UPCOMING",
"registration": {
"type": "RSVP",
"status": "OPEN_RSVP",
"rsvp": {
"responseType": "YES_ONLY",
"waitlistEnabled": false
},
"tickets": {
"guestsAssignedSeparately": false,
"ticketLimitPerOrder": 50,
"soldOut": true
},
"allowedGuestTypes": "VISITOR_OR_MEMBER",
"initialType": "RSVP",
"registrationPaused": false,
"registrationDisabled": false
},
"calendarUrls": {
"google": "http://calendar.google.com/calendar/render?action=TEMPLATE&text=Mindful+Living+Retreat%3A+Nurturing+Wellness+and+Inner+Peace&dates=20231028T180000Z%2F20231030T230000Z&location=&details=Thank+you+for+registering+to+our+event%21%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+event+details%3A%0A%0AMindful+Living+Retreat%3A+Nurturing+Wellness+and+Inner+Peace%0A28+October+2023+at+12%3A00+%E2%80%93+30+October+2023+at+17%3A00%0AEsalen+Institute",
"ics": "https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImM0MDI1MDgzLTA1YzMtNGVjNy1iNTE3LTVhZjEwNzk4NTZlM1wifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MzI2ODc5fQ.Wda2JNPHHEf0dYMMq0tjzCtK15e0R25H_EMPPhmR5Uk"
},
"eventPageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/event-details-registration/mindful-living-retreat-nurturing-wellness-and-inner-peace-2023-10-28-12-00"
},
"form": {
"controls": [
{
"type": "NAME",
"system": true,
"name": "name",
"inputs": [
{
"name": "firstName",
"array": false,
"label": "First name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"labels": []
},
{
"name": "lastName",
"array": false,
"label": "Last name",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 50,
"type": "TEXT",
"labels": []
}
],
"label": "First name, Last name",
"orderIndex": 0,
"id": "name"
},
{
"type": "INPUT",
"system": true,
"name": "email",
"inputs": [
{
"name": "email",
"array": false,
"label": "Email",
"additionalLabels": {},
"options": [],
"mandatory": true,
"maxLength": 255,
"type": "TEXT",
"labels": []
}
],
"label": "Email",
"orderIndex": 1,
"id": "email"
}
],
"messages": {
"rsvp": {
"rsvpYesOption": "I'm Going",
"rsvpNoOption": "Not Going",
"positiveMessages": {
"title": "Add your details",
"confirmation": {
"title": "Thank you!",
"message": "An email with all the event info was sent to you.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"waitlistMessages": {
"title": "Looks like this event is full. Join the waitlist.",
"confirmation": {
"title": "Thanks! You've been added to the waitlist.",
"message": "We'll update you if additional spots become available.",
"addToCalendarActionLabel": "Add to Calendar",
"shareActionLabel": "Share"
}
},
"negativeMessages": {
"title": "Add your details",
"confirmation": {
"title": "Sorry You Can't Make It",
"shareActionLabel": "Share"
}
},
"submitActionLabel": "SUBMIT"
},
"checkout": {
"title": "Add your details",
"submitActionLabel": "Continue"
},
"registrationClosed": {
"message": "Registration is closed",
"exploreEventsActionLabel": "See other events"
},
"ticketsUnavailable": {
"message": "Tickets are not on sale",
"exploreEventsActionLabel": "See other events"
}
}
},
"summaries": {
"rsvps": {
"totalCount": 0,
"yesCount": 0,
"noCount": 0,
"waitlistCount": 0
},
"tickets": {
"ticketsSold": 0,
"currencyLocked": false,
"totalOrders": 0
}
},
"instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b",
"guestListSettings": {
"displayedPublicly": false
},
"userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"feed": {
"token": {
"authorizerAppDefId": "140603ad-af8d-84a5-2c80-a0f60cb47351",
"claims": [
"wix.feed.FeedAccess",
"wix.comments.CommentsAccess",
"wix.reactions.ReactionsAccess"
],
"contextId": "c4025083-05c3-4ec7-b517-5af1079856e3",
"contextType": "events"
}
},
"onlineConferencing": {
"enabled": false,
"providerName": "",
"type": "UNKNOWN_ENUM_VALUE_Type_-1",
"session": {
"hostLink": "https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCJjNDAyNTA4My0wNWMzLTRlYzctYjUxNy01YWYxMDc5ODU2ZTNcIn0iLCJpYXQiOjE2ODkzMjY4Nzh9.XmXU6f_Vi5lVJt7-1Iv3kmHf0OSN4JULHleNwAsjhsg",
"guestLink": "https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcImM0MDI1MDgzLTA1YzMtNGVjNy1iNTE3LTVhZjEwNzk4NTZlM1wifSIsImlhdCI6MTY4OTMyNjg3OH0.Th5P_Tf7Ib5Ghwudv5HWSN9iWmTBBpjUKLA7XD52iSU"
}
},
"contactLabel": "custom.mindful-living-retreat-nurturing-wellness-and-inne",
"agendaSettings": {
"enabled": false,
"pageUrl": {
"base": "https://ievak9.wixsite.com/accessories",
"path": "/schedule/mindful-living-retreat-nurturing-wellness-and-inner-peace-2023-10-28-12-00"
}
},
"categories": [
{
"id": "eebe3ed6-ffef-46e4-a83a-e883d7ad8fdd",
"name": "Mindful Living Retreat: Nurturing Wellness and ...",
"createdDate": "2023-07-13T13:42:12.833Z",
"hidden": true,
"type": "RECURRING_EVENT"
}
]
}
},
"eventTime": "2023-07-14T09:27:59.333224Z",
"triggeredByAnonymizeRequest": false
}