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.

• React

• React Native

• Next.js

• Plain Javascript

• Flutter

👍

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.

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:

payload object has a property timestamp and some events extra data:

• 'SELECTED_INSTITUTION' has the connector property which is the connector selected by the user.
• 'LOGIN_SUCCESS' | 'LOGIN_MFA_SUCCESS' | 'LOGIN_STEP_COMPLETED' | 'ITEM_RESPONSE' events have the item property which is the item data related to the current connection.

Webhooks and callbacks

After a user makes a connection with Pluggy Connect widget, there are 2 ways to get the recently created item ID

Pluggy Connect Widget Callbacks

In the frontend of your application (website, application, etc), when you’re using Pluggy Connect widget, you get access to callbacks. (read callbacks) This way, you can pass the widget a function you need to execute when an event happens (for example an account connected successfully or with an error). What’s important here for you to know is that callbacks are used to improve the user experience, like redirecting users to a success page or showing an error message.

<PluggyConnect
    ...
    onSuccess={({ item }) => console.log(item.id)}
    onError={({message, data: {item}}) => showErrorPage(message)}
/>t

This approach is great for handling front-end logic, but it has the problem that it’s inconsistent and you cannot relay your Business Logic or DB integrity to it. Because for example, a user can close the application before the connection finishes successfully, and you will never realize that the connection finished.
To be consistent, we introduce Webhooks!

📘

onSuccess won't always be called!

Caixa Economica Federal (PF & PJ), has authorization flows that will require the user to authorize Pluggy as a trustable device, and the process has a delay of 30'.
In this scenario, you will receive an onError with the status USER_AUTHORIZATION_PENDING, and the SUCCESS event will be communicated via webhooks.

Webhooks

Webhook (also known as web callback) is a simple method that makes it easy for an app or system to provide real-time information whenever an event happens, that is, it is a way to passively receive data between two systems through an HTTP POST.

Webhooks will send your API / backend a notification when events related to connections happen. For example, you can get notified when an item is created or updated. (read more here)

You’ll need to create an endpoint to listen to Pluggy’s “ebhook events and then create a webhook pointing to that endpoint you created. More details about webhooks can be read in the documentation, but what’s important to understand here is that webhooks are the way to get the item ID of a connection for you to work on. Even though you can also retrieve the item ID with callbacks in the frontend, handling business logic with them is a bad practice, for example, a user closing the website they were making the connection on will result in you losing the item ID of that connection, meaning you’ll never be able to retrieve the item data.

Summary