getConnection( )


Developer Preview

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

Retrieves an external calendar connection by ID.

The external calendar connection contains details of the connection between a Wix site's calendar and calendars hosted by an external provider.

The syncConfig property contains configuration details for importing events from an external calendar, exporting events to an external calendar, or both.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
connectionIdstringRequired

ID of the connection to retrieve.

Returns
Return Type:Promise<GetConnectionResponse>
Was this helpful?
Yes
No