Environments and configurations
Get your web application quickly and seamlessly integrated to our platform by using our drop-in Connect Widget!
Currently available for the following environments:
Navigate to each project to find more detailed usage information in each README. You can also check out our Quickstarts repo to help you get started with your own integration.
Interested in contributing?
Let us know if you require or if you are interested in contributing a library for a language not represented here! Write us to [email protected]
Available configurations
Note: all parameters are optional, except for the connectToken.
| Property | Description | Type |
|---|---|---|
connectToken | Your Pluggy Connect token, which will be used to access the API. | string |
includeSandbox | Whether to display Sandbox connectors in the Connector selection step (not intended for production use) | boolean |
allowConnectInBackground | If true, Connect can be minimized by the user to continue the connection with the component hidden. | boolean |
updateItem | Item id to update. If specified, the modal will display directly the credentials form of the item to be updated. | string |
connectorTypes | List of Connector Types. If defined, only Connectors of the specified connector types will be listed. | ConnectorType[] |
connectorIds | List of Connector IDs. If defined, only Connectors of the specified connector IDs will be listed. | number[] |
selectedConnectorId | If specified, and the Connector is available, after accepting terms, the widget will navigate to this Connector login form directly, skipping connectors selection step. | number |
countries | List of country codes (ISO-3166-1 alpha 2 format). If defined, only Connectors of the specified countries will be listed. | CountryCode[] |
language | Language ISO string used to display the widget. If not specified, or selected language is not supported, the default language 'pt' will be used. | string |
theme | Theme to use for displaying the UI. Can be 'light' or 'dark'. Defaults to 'light'. | 'light' | 'dark' |
onSuccess | Function to execute when an Item has been created/updated successfully. | (data: { item: Item }) => void | Promise<void> |
onError | Function to execute on a general error loading the widget, or when an Item creation/update status has not been successful. | (error: { message: string; data?: { item: Item } }) => void | Promise<void> |
onOpen | Function to execute when the widget modal has been opened. | () => void | Promise<void> |
onClose | Function to execute when the widget modal has been closed. | () => void | Promise<void> |
onHide | Function to execute when the widget modal has been hidden, it will only call if allowConnectInBackground prop is set as true. | () => void | Promise<void> |
onEvent | Function to execute to handle custom user interaction events. See below for more info. | Function to execute to handle custom user interaction events. See below for more info. Since v2.0.0:(payload: ConnectEventPayload) => void | Promise<void>Until 1.x: (event: string, metadata: { timestamp: number }) => void |
onEvent
Use this callback to handle specific user interaction events.
The property event inside the payload of the onEvent is the current event triggered.
The available events that can be handled through this method are:
| Event name | Description |
|---|---|
'SUBMITTED_CONSENT' | User has confirmed terms & privacy consent on the first Welcome screen. |
'SELECTED_INSTITUTION' | User has selected an institution to connect to. |
'SUBMITTED_LOGIN' | User has submitted credentials to create the connection Item. |
'SUBMITTED_MFA' | User has submitted an extra parameter that has been requested by the institution to connect. |
'LOGIN_SUCCESS' | User has submitted credentials to create the connection Item successfully. |
'LOGIN_MFA_SUCCESS' | User has submitted an extra parameter that has been requested by the institution to connect successfully. |
'LOGIN_STEP_COMPLETED' | Successful completion of the login. User effectively logged in to the institution. |
'ITEM_RESPONSE' | Called every time the Item object is retrieved from Pluggy API, either when just created, updated, or each time it's retrieved to poll it's connection/execution status. |
payload object has a property timestamp and some events extra data:
'SELECTED_INSTITUTION'has theconnectorproperty which is the connector selected by the user.'LOGIN_SUCCESS' | 'LOGIN_MFA_SUCCESS' | 'LOGIN_STEP_COMPLETED' | 'ITEM_RESPONSE'events have theitemproperty which is the item data related to the current connection.
Updated about 1 month ago