POST

Connect By Credentials

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 List Events to obtain an up-to-date list of events in the connected external calendars.

This endpoint validates that the specified schedule is owned by the Wix user connecting the calendar, or that the caller has the Manage External Calendars or Manage Business Calendar permission scope.

If the schedule's ownership changes, the connection to the external calendar is automatically disconnected.

Note: Use List Providers to find out whether to connect to a particular provider using this endpoint or Connect by OAuth.

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.
Endpoint
POST
https://www.wixapis.com/bookings/v2/external-calendars/connections:connectByCredentials
Body Params
scheduleIdstringRequiredformat GUID

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

providerIdstringRequiredformat GUID

ID of the external calendar provider. Find this with the List Providers endpoint.

emailstringRequiredformat EMAIL

Email address for the external calendar account.

passwordstringRequired

Password for the external calendar account.

Response Object
connectionConnection

Established connection details.

Connect with an external calendar by credentials
Request
cURL
curl -X POST 'https://www.wixapis.com/bookings/v2/external-calendars/connections:connectByCredentials' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "providerId": "9f084ae8-b3a6-4eb6-a29d-bc682c04b5fc",
    "scheduleId": "3e47ec65-2975-447c-a7ed-75041e850d5e",
    "email": "some@email.com",
    "password": "abcd-dcba-abcd-dcba"
}'
Response
JSON
{
  "connection": {
    "id": "4WnvD8QzxhkAjVPBKUCvLIMpbuuUCMID7rYhqOpIGDae9JYyQj0JS71sdJukve86B38sWvS6TOvMQqBxszjEMNrrx8EGfFr5KhzpkCmfjBNJx2MSLZEkgEzGqEHtRYJ92LTUJ2w5v87FG2DafDaN3VSfbRlvSEqzXlgbEapLhGsm976gGw90KJd",
    "providerId": "9f084ae8-b3a6-4eb6-a29d-bc682c04b5fc",
    "calendarType": "I_CAL",
    "scheduleId": "3e47ec65-2975-447c-a7ed-75041e850d5e",
    "userId": "f7f363b1-8ef8-4118-9612-0e6b3910745a",
    "externalAccountEmail": "some@email.com",
    "status": "CONNECTED"
  }
}
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?