Link back to your site from Connect

For every Connect Session, it is possible to define a callbackUrl. This URL can be used to redirect the user whenever their intended action in Connect has been completed or in case of an error.

The callbackUrl can be a deep link.

Successful action completion

Whenever the user has successfully completed the intended action in Connect, they will be redirected to the callbackUrl with the following query parameters:

  • session_id: The ID of the Connect Session that was completed
  • status: A status code indicating that the action was completed successfully. Currently, this is always going to be success.

Error handling

It's important to provide users with clear feedback when they are redirected to the callbackUrl due to an error.

When an error occurs with the Connect Session, Connect will add specific query parameters to your callback URL to give you information about the issue:

  • session_id: The ID of the Connect Session that encountered the problem
  • status: An error code that indicates the reason for the Connect Session's failure

Additionally, if you have added your own query parameters to the URL when creating the Connect Session, Connect will keep them intact when appending the query parameters listed above.

Status codes

  • auth_expired: The Connect session was no longer valid when the access attempt was made
  • bad_configuration: The Connect Session attempted to start a flow that was not allowed for the current configuration
  • user_aborted: The Connect Session was intentionally aborted by a user action

Intent fulfilled

This is not yet implemented in Connect Sessions. We are actively working on extending Connect Sessions to provide this functionality.