connectByCredentials( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Connects to an external calendar by directly providing the external calendar account credentials.

Once a connection is successfully created, use listEvents() to obtain an up-to-date list of events in the connected external calendars.

Note: Use listProviders() to find out whether to connect to a particular provider using this method or connectByOAuth().

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

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:

See the entire list and learn more about Wix errors.

Did this help?