> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Package: eventManagement # Namespace: eventsSettings # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/events/event-management/events-settings/events-settings-updated.md ## Introduction Triggered when Events Settings are updated. --- ## REST API ### Schema ``` Webhook: Events Settings Updated Description: Triggered when Events Settings are updated. Event body: - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events. - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event. - name: slug | type: string | description: Event name. - name: entityId | type: string | description: ID of the entity associated with the event. - name: eventTime | type: string (date-time) | description: Event timestamp. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR. - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: updatedEvent | type: object | description: Updated event details. - name: currentEntity | type: EventsSettings | description: The entity after the update. - name: id | type: string | description: Events Settings GUID. - name: createdDate | type: string | description: Date and time the Events Settings were created. - name: updatedDate | type: string | description: Date and time the Events Settings were last updated. - name: revision | type: string | description: Revision number, which increments by 1 each time the Events Settings are updated. To prevent conflicting changes, the current revision must be passed when updating the Events Settings. - name: siteInfo | type: SiteInfo | description: Site information including locale, language, and available premium features. - name: locale | type: string | description: Site locale in IETF BCP 47 language tag format. For example, `en-US` for U.S. English. - name: language | type: string | description: Site language in ISO 639-1 alpha-2 format. For example, `en`. - name: premiumFeatures | type: array | description: Premium features available to the site. These features control access to advanced events capabilities. Use this array to determine which functionality to enable in your integration. For example, check for `SELL_TICKETS` before showing payment options. - enum: - SELL_TICKETS: Enables paid ticket sales for events. When present, the site can create paid ticket definitions and process payments through configured payment providers. - INCLUDE_URL_IN_EMAIL: Allows including custom URLs in event notification emails sent to attendees. Useful for adding registration links, additional information, or branded content in emails. - HIDE_FOOTER_IN_EMAIL: Removes Wix branding from event notification emails. Provides a fully customized email without Wix attribution in the footer. - name: eventsInfo | type: EventsInfo | description: Global information about the site's events, including whether any events have been created and current ticket sales status. - name: firstEventCreated | type: boolean | description: Whether the site has created its first event. - name: sellingTickets | type: boolean | description: Whether any events on the site sell tickets, including both free and paid tickets. - name: sellingPaidTickets | type: boolean | description: Whether any events on the site sell paid tickets specifically. Requires both ticket definitions with non-zero prices and the `SELL_TICKETS` premium feature. - name: serviceFeeSettings | type: ServiceFeeSettings | description: Settings for Wix service fees applied to paid ticket sales. - name: serviceFeeEnabled | type: boolean | description: Whether Wix service fees are applied to paid ticket sales. - name: paymentSettings | type: PaymentSettings | description: Payment configuration including available payment methods, coupon acceptance, and delayed capture settings. - name: ticketSalesEnabled | type: boolean | description: Whether ticket sales are enabled for the site. Free ticket sales are always available; paid ticket sales require the `SELL_TICKETS` premium feature and configured payment providers. - name: activePaymentMethods | type: array | description: Payment methods currently available for ticket checkout. Automatically populated based on the site's payment provider configuration. Common methods include credit cards, PayPal, and digital wallets. - name: methodId | type: string | description: Payment method identifier indicating the type of payment accepted. For example, `creditCard`, `payPal`, `applePay`, or `googlePay`. Use this to determine which payment options to display in checkout. - name: couponsAccepted | type: boolean | description: Whether discount coupons can be used during ticket checkout. Automatically enabled when at least one coupon exists on the site. - name: giftCardsAccepted | type: boolean | description: Whether gift cards can be used during ticket checkout. Requires gift card functionality to be enabled at the site level. - name: delayedPaymentCaptureSettings | type: DelayedPaymentCaptureSettings | description: Configuration for delayed payment capture, allowing payments to be authorized at purchase but captured later. This setting applies to all events on the site and can be updated through the API. - name: enabled | type: boolean | description: Whether delayed payment capture is enabled for all ticket sales on the site. When enabled, payments are authorized at purchase but captured later. - name: modifiedFields | type: Map | description: Fields that were updated and their values before the update. ``` ### Examples ```curl { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "entityFqdn": "wix.events.v1.ticket_reservation", "slug": "updated", "entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47", "updatedEvent": { "currentEntity": { "id": "8046df3c-7575-4098-a5ab-c91ad8f33c47", "revision": 1, "createdDate": "2019-10-30T17:22:10.299Z", "updatedDate": "2019-10-30T17:22:10.299Z", "siteInfo": { "locale": "en-US", "language": "en", "premiumFeatures": ["SELL_TICKETS", "INCLUDE_URL_IN_EMAIL"] }, "eventsInfo": { "firstEventCreated": true, "sellingTickets": true, "sellingPaidTickets": false }, "paymentSettings": { "ticketSalesEnabled": true, "activePaymentMethods": [ { "methodId": "creditCard" }, { "methodId": "payPal" } ], "couponsAccepted": true, "giftCardsAccepted": false, "delayedPaymentCaptureSettings": { "enabled": false } } }, "eventTime": "2019-10-30T17:25:15.456Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": 2 } } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onEventsSettingsUpdated Description: Triggered when Events Settings are updated. Payload: EventsSettingsUpdatedEnvelope - name: entity | type: EventsSettings | description: none - name: _id | type: string | description: Events Settings GUID. - name: _createdDate | type: Date | description: Date and time the Events Settings were created. - name: _updatedDate | type: Date | description: Date and time the Events Settings were last updated. - name: revision | type: string | description: Revision number, which increments by 1 each time the Events Settings are updated. To prevent conflicting changes, the current revision must be passed when updating the Events Settings. - name: siteInfo | type: SiteInfo | description: Site information including locale, language, and available premium features. - name: locale | type: string | description: Site locale in IETF BCP 47 language tag format. For example, `en-US` for U.S. English. - name: language | type: string | description: Site language in ISO 639-1 alpha-2 format. For example, `en`. - name: premiumFeatures | type: array | description: Premium features available to the site. These features control access to advanced events capabilities. Use this array to determine which functionality to enable in your integration. For example, check for `SELL_TICKETS` before showing payment options. - enum: - SELL_TICKETS: Enables paid ticket sales for events. When present, the site can create paid ticket definitions and process payments through configured payment providers. - INCLUDE_URL_IN_EMAIL: Allows including custom URLs in event notification emails sent to attendees. Useful for adding registration links, additional information, or branded content in emails. - HIDE_FOOTER_IN_EMAIL: Removes Wix branding from event notification emails. Provides a fully customized email without Wix attribution in the footer. - name: eventsInfo | type: EventsInfo | description: Global information about the site's events, including whether any events have been created and current ticket sales status. - name: firstEventCreated | type: boolean | description: Whether the site has created its first event. - name: sellingTickets | type: boolean | description: Whether any events on the site sell tickets, including both free and paid tickets. - name: sellingPaidTickets | type: boolean | description: Whether any events on the site sell paid tickets specifically. Requires both ticket definitions with non-zero prices and the `SELL_TICKETS` premium feature. - name: serviceFeeSettings | type: ServiceFeeSettings | description: Settings for Wix service fees applied to paid ticket sales. - name: serviceFeeEnabled | type: boolean | description: Whether Wix service fees are applied to paid ticket sales. - name: paymentSettings | type: PaymentSettings | description: Payment configuration including available payment methods, coupon acceptance, and delayed capture settings. - name: ticketSalesEnabled | type: boolean | description: Whether ticket sales are enabled for the site. Free ticket sales are always available; paid ticket sales require the `SELL_TICKETS` premium feature and configured payment providers. - name: activePaymentMethods | type: array | description: Payment methods currently available for ticket checkout. Automatically populated based on the site's payment provider configuration. Common methods include credit cards, PayPal, and digital wallets. - name: methodId | type: string | description: Payment method identifier indicating the type of payment accepted. For example, `creditCard`, `payPal`, `applePay`, or `googlePay`. Use this to determine which payment options to display in checkout. - name: couponsAccepted | type: boolean | description: Whether discount coupons can be used during ticket checkout. Automatically enabled when at least one coupon exists on the site. - name: giftCardsAccepted | type: boolean | description: Whether gift cards can be used during ticket checkout. Requires gift card functionality to be enabled at the site level. - name: delayedPaymentCaptureSettings | type: DelayedPaymentCaptureSettings | description: Configuration for delayed payment capture, allowing payments to be authorized at purchase but captured later. This setting applies to all events on the site and can be updated through the API. - name: enabled | type: boolean | description: Whether delayed payment capture is enabled for all ticket sales on the site. When enabled, payments are authorized at purchase but captured later. - name: modifiedFields | type: Map | description: Fields that were updated and their values before the update. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - name: metadata | type: EventMetadata | description: none - name: instanceId | type: string | description: App instance GUID. - name: eventType | type: string | description: Event type. - name: identity | type: IdentificationData | description: The identification type and identity data. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). - name: appId | type: string | description: GUID of an app. - name: identityType | type: WebhookIdentityType | description: - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP - name: accountInfo | type: AccountInfo | description: Details related to the account - name: accountId | type: string | description: GUID of the Wix account associated with the event. - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account. - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site. - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them. - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. - name: entityId | type: string | description: GUID of the entity associated with the event. - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. ``` ### Examples ```javascript import { eventsSettings } from '@wix/events'; eventsSettings.onEventsSettingsUpdated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { eventsSettings } from '@wix/events'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { eventsSettings, }, }); wixClient.eventsSettings.onEventsSettingsUpdated((event) => { // handle your event here }); ``` ---