getConnection( )

Developer Preview

Retrieves an external calendar connection by ID.

Description

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.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function getConnection(connectionId: string): Promise<GetConnectionResponse>

getConnection Parameters

NAME

TYPE

DESCRIPTION

connectionId

string

ID of the connection to retrieve.

Returns

Return Type:

Promise<

GetConnectionResponse

NAME

TYPE

DESCRIPTION

connection

Connection

Retrieved external calendar connection.

Was this helpful?

Get an external calendar connection by ID

Copy Code

1import {externalCalendars} from 'wix-bookings.v2';
2
3async function getConnection(connectionId) {
4    const {connection} = await externalCalendars.getConnection(connectionId)
5    return connection
6}