Connection flow for an Integrated account

This document describes the flow of events that happen when an integrated account is connected. This is useful for understanding the different steps involved in the connection process and for debugging any issues that may arise during the connection process.

end-user refers to the user who is connecting their account.

1. Integrated account is created: When an integrated account is created, Truto will send an integrated_account:created webhook event. This event will contain the integrated account as the payload.
2. Post install steps run: Post install steps are requests, transformations and other steps that are defined on the integration to make the Unified and Proxy APIs work properly. These steps are run after the integrated account is created. If any of these steps fail, Truto will send an integrated_account:post_install_error webhook event. This event will contain the integrated account as the payload, the end-user will be notified on the connection screen and Truto Link SDK will throw an error. Post install steps are not defined on all the integrations.
3. Connection validation steps run: Connection validation steps are Unified and Proxy API requests that are defined on the integration to make sure that the connection is valid and has the necessary permissions required for making the API calls. If any of these steps fail, Truto will send an integrated_account:validation_error webhook event. This event will contain the integrated account as the payload, the end-user will be notified on the connection screen and Truto Link SDK will throw an error. Connection validation steps are not defined by Truto and can be configured by you in the installed integration details page.
4. Integrated account is activated: The integrated account is now ready to use -- Unified and Proxy API calls be made against this integrated account, Truto will send an integrated_account:active webhook event. This event will contain the integrated account as the payload. This event is sent after the post install and connection validation steps are run.
5. Post connect form (RapidForm) submitted: If a post connect form (RapidForm) is defined on the installed integration, Truto will send an integrated_account:post_connect_form_submitted webhook event when the user submits the RapidForm on the connection screen. This event will contain the integrated account as the payload. This event is sent after the integrated account is activated.

WARNING

If the post install steps or connection validation steps fail, the integrated account will not be automatically deleted. You will have to delete the integrated account manually.