> 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 # GetEventsSettings # Package: eventManagement # Namespace: EventsSettingsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/event-management/events-settings/get-events-settings.md ## Permission Scopes: Manage Events: SCOPE.DC-EVENTS.MANAGE-EVENTS ## Introduction Retrieves the current events settings for a site. --- ## REST API ### Schema ``` Method: getEventsSettings Description: Retrieves the current events settings for a site. URL: https://www.wixapis.com/v1/events-settings Method: GET Method parameters: query param name: fields | type: array | description: Settings categories to include in the response. If omitted, returns only basic settings for performance optimization. Use this to request specific information like premium features or payment settings. - enum: - SITE_INFO: Returns site information including locale, language, and available premium features that determine Events capabilities. - EVENTS_INFO: Returns Events-related information like first event creation status and current ticket sales flags. - SERVICE_FEE_SETTINGS: Returns Wix service fee configuration, activation status, and agreement dates. - PAYMENT_SETTINGS: Returns available payment methods, delayed capture settings, and payment acceptance configuration. Return type: GetEventsSettingsResponse - name: eventsSettings | type: EventsSettings | description: The Events Settings object containing the requested configuration and status information. - 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. ``` ### Examples ### Get Events Settings ```curl curl -X GET \ 'https://www.wixapis.com/events/v1/settings?fields=SITE_INFO&fields=EVENTS_INFO&fields=PAYMENT_SETTINGS' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.eventManagement.EventsSettingsService.getEventsSettings(options) Description: Retrieves the current events settings for a site. Method parameters: param name: options | type: GetEventsSettingsOptions none - name: fields | type: array | description: Settings categories to include in the response. If omitted, returns only basic settings for performance optimization. Use this to request specific information like premium features or payment settings. - enum: - SITE_INFO: Returns site information including locale, language, and available premium features that determine Events capabilities. - EVENTS_INFO: Returns Events-related information like first event creation status and current ticket sales flags. - SERVICE_FEE_SETTINGS: Returns Wix service fee configuration, activation status, and agreement dates. - PAYMENT_SETTINGS: Returns available payment methods, delayed capture settings, and payment acceptance configuration. Return type: PROMISE - name: eventsSettings | type: EventsSettings | description: The Events Settings object containing the requested configuration and status information. - 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. ``` ### Examples ### getEventsSettings ```javascript import { eventsSettings } from '@wix/events'; async function getEventsSettings(options) { const response = await eventsSettings.getEventsSettings(options); }; ``` ### getEventsSettings (with elevated permissions) ```javascript import { eventsSettings } from '@wix/events'; import { auth } from '@wix/essentials'; async function myGetEventsSettingsMethod(options) { const elevatedGetEventsSettings = auth.elevate(eventsSettings.getEventsSettings); const response = await elevatedGetEventsSettings(options); } ``` ### getEventsSettings (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { eventsSettings } from '@wix/events'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { eventsSettings }, // Include the auth strategy and host as relevant }); async function getEventsSettings(options) { const response = await myWixClient.eventsSettings.getEventsSettings(options); }; ``` ---