connectByCredentials( )


Connects a Wix schedule (SDK | REST) to an external calendar account using credentials.

Next steps

After connecting an external calendar account to a Wix schedule, you can do the following.

Check the 2-way-sync settings

Call List Connections (SDK | REST) and filter by the relevant schedule ID.

If needed, call Update Sync Config (SDK | REST) to adjust the syncing configuration.

Retrieve external calendar events

Once a connection is successfully created, you can call List Events (SDK | REST) to obtain an up-to-date list of events in the connected external calendars.

When to call Connect By OAuth instead

You could call Connect By OAuth (SDK | REST) if:

  • The external calendar provider doesn't support authorization by credentials.
  • You don't have access to the external calendar account credentials.
  • You want the account owner to approve the connection.

Call List Providers (SDK | REST) for a complete list of external calendar providers supported on the Wix site, including which authorization methods they support.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
providerIdstringRequired

ID of the external calendar provider. Find this with the listProviders() function.


scheduleIdstringRequired

ID of the schedule to connect with the external calendar account.


emailstringRequired

Email address for the external calendar account.


passwordstringRequired

Password for the external calendar account.

Returns
Return Type:Promise<ConnectByCredentialsResponse>
Errors
401Unauthenticated

There is 1 error with this status code.

403Permission Denied

There is 1 error with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?