With the Ticket Definitions API, you can create definitions for tickets. A definition includes the following ticket settings:
It’s important to note the following points before starting to code:
The following table shows field support for filters and sorting for the Ticket Definition object:
Field | Query Filter Operators | Sortable |
---|---|---|
id | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
eventId | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
name | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
description | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
limit | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
pricing_method.pricing_type | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
feeType | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
saleStatus | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
updatedDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
createdDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
hidden | $eq , $ne , $in , $nin , $exists | Sortable |
pricing_method.free | $eq , $ne , $in , $nin , $exists | Sortable |
Related content: API Query Language, Ticket Definitions 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 how you can update your event site with a ticket counter for specific-price tickets. This counter provides real-time information on the availability of tickets for customers to see. For example, your page can have a counter that says "Only 3 tickets left for this price." By displaying the number of tickets remaining, you can motivate customers to buy tickets promptly.
Note: This flow assumes you have already created the UI component of the counter for your site.
To create a ticket counter, follow these steps:
salesDetails.unsoldCount
and fixedPrice.value
values (for fixedPrice
pricing method).salesDetails.unsoldCount
and pricingOptions.optionDetails.price.value
field values (for optionalPrice
pricing method).Pass these retrieved values in your app to initialize the counter on your website, displaying the number of available tickets at the specified price.
On an ongoing basis, listen for each new ticket purchase using the Order Confirmed Webhook.
When the webhook is triggered, you'll receive an order in the payload. Retrieve the ticketDefinitionId
value from the event data.
Send the extracted ticketDefinitionId
value to your site and compare it with the ticket definition ID for which the counter is set. If they match, call Get Ticket Definition again to retrieve the updated salesDetails.unsoldCount
value. Send this new decreased value to your website to update the ticket counter.
If you're using a Wix site to manage events and another system to handle ticketing, you can synchronize ticket definitions between them whenever a definition is updated on the site. This includes aspects such as ticket types, pricing, availability, and any other relevant ticket settings. This synchronization eliminates the need for manual updates and reduces the risk of discrepancies between systems.
To upload and update all ticket definitions defined on the Wix site to your external system for the first time, follow these flows:
Create a custom field in your system that stores the ticket definition ID for a particular event to ensure a 1-to-1 relationship with the external ticketing system. Craft your code so that this ID won't be overwritten by future updates from your app.
Create a mapping from the site ticket definition fields to the system fields that will be used whenever site ticket definitions and the external system are synchronized.
Query Ticket Definitions by eventId
and send the relevant information to the external ticketing system.
On an ongoing basis, listen for changes to site ticket definitions with these webhooks:
When one of the above webhooks is triggered, you'll receive the ticket definition in the payload. You can bring those changes to the ticketing system by retrieving the relevant info from the payload, and use mapping to take action on the external system:
For created and updated ticket definitions retrieve the relevant info from the createdEvent.currentEntity
object.
For deleted ticket definitions retrieve the createdEvent.currentEntity.id
value.
Let customers know when ticket sales for an event begin. You can send automated notifications to customers with email or push notifications. These notifications make customers aware of ticket availability so they can secure their tickets promptly.
Note: This flow assumes your customers already have the ability to subscribe to your newsletters.
To send notifications about the start of ticket sales, follow these steps:
Retrieve the salePeriod.startDate
field value, and write your code so that the value can be passed to your marketing tool.
Request and filter the list of subscribers in your external marketing tool based on customers subscription status for the current event.
When the ticket sale start date arrives, send notifications to your customers who have opted in to receive marketing emails.
Ticket definition ID.
Event ID to which the ticket definition belongs.
Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
Date and time when the ticket definition was created.
Date and time when the ticket definition was updated.
Ticket definition name.
Ticket definition description.
Ticket definition policy.
Whether this ticket definition is hidden to site visitors and can't be purchased.
Whether the ticket has a limited maximum quantity.
The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and actualLimit
is used instead.
The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as initialLimit
.
Ticket pricing method.
Whether fee is included in the ticket price or customer pays it additionally at checkout.
Ticket sale period.
Ticket sale status.
Ticket sales information.
Note: This field is only returned when SALES_DETAILS
fieldset is included in the request.
Number of tickets that can be purchased per checkout.
Note: If the actuaLimit
or salesDetails.unsoldCount
field value is smaller than limitPerCheckout
, then it overrides this field.
Data extensions.
Associated event information.
Note: This field is only returned when EVENT_DETAILS
fieldset is included in the request.
{
"ticketDefinition": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T11:39:26.108Z",
"name": "Leather Workshop",
"description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.",
"policy_text": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_ENDED",
"salesDetails": {
"unsoldCount": 3,
"soldCount": 0,
"reservedCount": 0,
"soldOut": false
}
}
}
Creates a ticket definition. Allowed to create up to 100 definitions per event.
You can only call this method when authenticated as a Wix app or Wix user identity.
Ticket definition info.
Predefined sets of fields to return.
Created ticket definition.
curl -X POST 'cv3/ticket-definitions' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"ticketDefinition": {
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"name": "Leather Workshop",
"description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"initialLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200",
"currency": "USD"
}
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
}
},
"fields": ["SALES_DETAILS"]
}'
{
"ticketDefinition": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T11:39:26.108Z",
"name": "Leather Workshop",
"description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_ENDED",
"salesDetails": {
"unsoldCount": 3,
"soldCount": 0,
"reservedCount": 0,
"soldOut": false
}
}
}
There are 3 errors with this status code:
See the entire list and learn more about Wix errors.
Updates a ticket definition.
Each time the ticket definition is updated, revision
increments by 1. The existing revision
must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites.
You can only call this method when authenticated as a Wix app or Wix user identity.
Ticket definition ID.
Ticket definition to update.
Predefined sets of fields to return.
The updated ticket definition.
curl -X PATCH 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/aaf51c30-a61c-473e-96be-a42dfa5064c0' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"ticketDefinition": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"name": "Leather Workshop",
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
}
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-08T10:00:00Z"
},
},
"mask": {
"salePeriod.startDate"
}
}'
{
"ticketDefinition": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "2",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T13:44:58.775Z",
"name": "Leather Workshop",
"description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-08T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_STARTED",
"salesDetails": null
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Retrieves a ticket definition by ID.
You can only call this method when authenticated as a Wix app or Wix user identity.
Ticket definition ID.
Predefined sets of fields to return.
The requested ticket definition.
curl -X GET 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/aaf51c30-a61c-473e-96be-a42dfa5064c0' \
-H 'Authorization: <AUTH TOKEN>'
{
"ticketDefinition": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T11:39:26.108Z",
"name": "Leather Workshop",
"description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_ENDED",
"salesDetails": null
}
}
Permanently deletes a ticket definition.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the ticket definition to delete.
curl -X DELETE 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/625115fd-31cb-4f64-b7bd-06c3137486c0' \
-H 'Authorization: <AUTH TOKEN>' \
{}
Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.
Note: It is possible to use both beforeTicketDefinitionId
and afterTicketDefinitionId
at the same time but only the last one defined will be executed.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Ticket definition ID.
Move the given definitionId
before the referenced ticket definition.
Move the given definitionId
after the referenced ticket definition.
curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/reorder' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"ticketDefinitionId": "625115fd-31cb-4f64-b7bd-06c3137486c0",
"beforeTicketDefinitionId": "7ffbabb4-708c-449b-a956-78d153cd1faa"
}'
{}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting. Query Ticket Definitions runs with these defaults, which you can override:
createdDate
is sorted in ASC
orderpaging.limit
is 100
paging.offset
is 0
For field support for filters and sorting, see Ticket Definitions: Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language.
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.
Predefined sets of fields to return.
List of ticket definitions.
Metadata for the paginated results.
curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/query' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"query": {
"filter": {
"createdDate": {
"$gt": "2023-05-25T00:00:00.000Z"
}
},
"fields": [ "SALES_DETAILS" ]
}
}'
{
"ticketDefinitions": [
{
"id": "625115fd-31cb-4f64-b7bd-06c3137486c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"createdDate": "2023-05-25T12:41:24.422Z",
"updatedDate": "2023-05-25T12:41:24.422Z",
"name": "Shoemaking for Beginners",
"description": "Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 12,
"actualLimit": 12,
"pricingMethod": {
"pricingOptions": {
"optionDetails": [
{
"optionId": "e63f7f77-ce5d-487b-b585-af30d103fbc8",
"name": "Regular Ticket",
"price": {
"value": "50.00",
"currency": "USD"
}
},
{
"optionId": "6e409caa-6183-47f1-b0d6-c78b7047f3b2",
"name": "Student Ticket",
"price": {
"value": "25.00",
"currency": "USD"
}
}
]
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-07-14T10:00:00Z",
"endDate": "2023-07-22T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_ENDED",
"salesDetails": {
"unsoldCount": 12,
"soldCount": 0,
"reservedCount": 0,
"soldOut": false
}
},
{
"id": "7ffbabb4-708c-449b-a956-78d153cd1faa",
"eventId": "39d16ecc-0ec8-4764-8077-8e991f20ef9d",
"revision": "1",
"createdDate": "2023-05-25T12:06:15.815Z",
"updatedDate": "2023-05-25T12:06:15.815Z",
"name": "Gospel Concert",
"description": "Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 50,
"actualLimit": 50,
"pricingMethod": {
"guestPrice": {
"value": "2.00",
"currency": "USD"
},
"pricingType": "DONATION",
"free": false
},
"feeType": "FEE_ADDED_AT_CHECKOUT",
"salePeriod": {
"startDate": "2023-06-28T10:00:00Z",
"endDate": "2023-07-08T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_ENDED",
"salesDetails": {
"unsoldCount": 3,
"soldCount": 0,
"reservedCount": 0,
"soldOut": false
}
}
],
"metadata": {
"count": 2,
"offset": null,
"total": null,
"tooManyToCount": null,
"cursors": {
"next": null,
"prev": null
}
}
}
Counts ticket definitions by the saleStatus
field, including those with the hidden
status.
You can only call this method when authenticated as a Wix app or Wix user identity.
Filter object in the following format:
"filter" : { "fieldName1": "value1" }
.
Parameters to count ticket definitions by.
Metadata for the paginated results.
Filter facets.
curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/count' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"filter": {
"saleStatus": {
"$eq": "SALE_STARTED"
}
},
"facet": ["saleStatus"]
}'
{
"metadata": {
"total": 4
},
"facets": {
"saleStatus": {
"counts": {
"SALE_STARTED": 4
}
}
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Deletes multiple ticket definitions.
All ticket definitions that meet the specified filter
criteria are deleted.
You can only call this method when authenticated as a Wix app or Wix user identity.
Filter object in the following format:
"filter" : { "fieldName1": "value1" }
.
Example:
"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }
curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/bulk/ticket-definitions/delete' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
"filter": {
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18"
}
}'
{}
Changes ticket price currency per event.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Ticket price currency in 3-letter ISO-4217 alphabetic format.
curl -X POST 'https://www.wixapis.com/events-ticket-definitions/v3/ticket-definitions/currency' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"currency": "USD"
}'
{}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Triggered when a ticket definition 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.ticket_definition
.
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.ticket_definition_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": "9aca3895-8c58-48b7-84a5-35bcd431c125",
"entityFqdn": "wix.events.ticketdef.v3.ticket_definition",
"slug": "created",
"entityId": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"createdEvent": {
"entity": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T11:39:26.108Z",
"name": "Leather Workshop",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_SCHEDULED"
}
},
"eventTime": "2023-05-25T11:39:26.278160Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "1"
}
Triggered when a ticket definition 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.ticket_definition
.
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.ticket_definition_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": "85deb868-5896-4a44-8f0a-3544eb432216",
"entityFqdn": "wix.events.ticketdef.v3.ticket_definition",
"slug": "deleted",
"entityId": "077766f0-ffa4-4fa1-bdf8-dbb0439c1892",
"deletedEvent": {},
"eventTime": "2023-05-25T10:57:03.945444Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a ticket sale ends. Sales details are not included in the payload.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.ticket_definition
.
Event name. Expected sale_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.ticket_definition_sale_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": "7cf9dc1b-be64-4394-b748-21de6bed31f1",
"entityFqdn": "wix.events.ticketdef.v3.ticket_definition",
"slug": "sale_ended",
"entityId": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"actionEvent": {
"body": {
"ticketDefinition": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T11:39:26.108Z",
"name": "Leather Workshop",
"description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_ENDED"
}
}
},
"eventTime": "2023-05-25T13:44:59.129216Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a sale period 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.ticket_definition
.
Event name. Expected sale_period_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.ticket_definition_sale_period_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": "7cf9dc1b-be64-4394-b748-21de6bed31f1",
"entityFqdn": "wix.events.ticketdef.v3.ticket_definition",
"slug": "sale_period_updated",
"entityId": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"updatedEvent": {
"currentEntity": {
"afterUpdate": {
"startDate": "2023-06-08T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
}
}
},
"eventTime": "2023-05-25T13:44:59.129216Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a ticket sale starts. Sales details are not included in the payload.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v3.ticket_definition
.
Event name. Expected sale_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.ticket_definition_sale_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": "7cf9dc1b-be64-4394-b748-21de6bed31f1",
"entityFqdn": "wix.events.ticketdef.v3.ticket_definition",
"slug": "sale_started",
"entityId": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"actionEvent": {
"body": {
"ticketDefinition": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "1",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T11:39:26.108Z",
"name": "Leather Workshop",
"description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.",
"policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_STARTED"
}
}
},
"eventTime": "2023-05-25T13:44:59.129216Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a ticket definition 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.ticket_definition
.
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.ticket_definition_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": "7cf9dc1b-be64-4394-b748-21de6bed31f1",
"entityFqdn": "wix.events.ticketdef.v3.ticket_definition",
"slug": "updated",
"entityId": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"updatedEvent": {
"currentEntity": {
"afterUpdate": {
"id": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
"eventId": "9d720f99-1b5a-4141-9877-d32985391e18",
"revision": "2",
"createdDate": "2023-05-25T11:39:26.108Z",
"updatedDate": "2023-05-25T13:39:26.108Z",
"name": "Leather Workshop",
"hidden": false,
"limited": true,
"initialLimit": 3,
"actualLimit": 3,
"pricingMethod": {
"fixedPrice": {
"value": "200.00",
"currency": "USD"
},
"pricingType": "STANDARD",
"free": false
},
"feeType": "FEE_INCLUDED",
"salePeriod": {
"startDate": "2023-06-07T10:00:00Z",
"endDate": "2023-06-30T00:00:00Z",
"displayNotOnSale": false
},
"saleStatus": "SALE_SCHEDULED"
}
}
},
"eventTime": "2023-05-25T13:44:59.129216Z",
"triggeredByAnonymizeRequest": false
}