Creates a new external database connection.
The externalDatabaseConnection parameter must include a name, endpoint, and configuration details for the external database.
If any of these are missing, the external database connection isn't created.
You can only call this method when authenticated as a Wix app or Wix user identity.
External database connection details.
Connection type.
Learn more about connection types.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Deletes an external database connection.
Note: Once an external database connection is deleted, it can't be restored. To reconnect the database you need to create a new external database connection.
You can only call this method when authenticated as a Wix app or Wix user identity.
Name of the external database connection to delete.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Retrieves the specified external database connection.
You can only call this method when authenticated as a Wix app or Wix user identity.
Name of the external database connection to retrieve.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Lists the site's external database connections.
Note: The method lists both connection types.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Updates an external database connection.
An external database collection name must be provided in name.
If an existing external database connection is found with the same name, that connection's details are updated.
If no external database connection has that name, the request fails.
Note: After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.
You can only call this method when authenticated as a Wix app or Wix user identity.
Name of the external database connection.
An external database connection can connect to one or more external data collections or tables. These appear as connectionName/dataCollectionId.
Updated external database connection details. The existing connection is replaced with this version.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Triggered when an external database connection is created.
handler(event: ExternalDatabaseConnectionCreatedEnvelope): void | Promise<void>
Triggered when an external database connection is deleted.
handler(event: ExternalDatabaseConnectionDeletedEnvelope): void | Promise<void>
Triggered when an external database connection is updated.
handler(event: ExternalDatabaseConnectionUpdatedEnvelope): void | Promise<void>