POST

Create Redirect Session

Creates a URL for redirecting a visitor from an external client site to a Wix page for Wix-managed functionality.

The Create Redirect Session method enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes. For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for bookings, eCommerce, events, or paid plans transactions.

To initiate a redirect session:

  1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect the visitor back to your site as appropriate when the process is over.
  2. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
  3. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
Permissions
Manage Bookings Services and Settings
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/_api/redirects-api/v1/redirect-session
Body Params
callbacksCallbacks

Details of pages to redirect the visitor back to on the Wix Headless client site. When redirecting to any callback URL, Wix specifies the boolean wixMemberLoggedIn parameter. If true, a member logged in during the preceding Wix-managed process.

Note: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in auth.authRequest.redirectUri.

preferencesPreferences

Optional preferences for customizing redirection to Wix pages.

One Of
Required
Choose one of the following parameters
bookingsCheckoutBookingsCheckout

Information required for generating a custom URL for a Wix Bookings checkout.

ecomCheckoutEcomCheckout

Information required for generating a custom URL for a Wix eCommerce checkout.

eventsCheckoutEventsCheckout

Information required for generating a custom URL for a Wix Events checkout.

paidPlansCheckoutPaidPlansCheckout

Information required for generating a custom URL for a Wix Paid Plans checkout.

loginLogin

Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated.

logoutLogout

Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser.

authAuth

Information required for generating a custom URL for Wix authentication.

storesProductStoresProduct

Information required for generating a custom URL for a Wix stores product page.

bookingsBookBookingsBook

Information required for generating a custom URL for Wix bookings book page.

Response Object
redirectSessionRedirectSession

Details for redirecting the visitor to a Wix page.

Create a redirect session for an eCommerce checkout
Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Redirect Session Created
Did this help?