Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • redirectUrl, to which the Web Form will redirect the user after the Web Form flow is completed successfully. You can include encoded query parameters in the redirectUrl as well, they will be contained in the redirect. If you don't pass a redirectUrl, the Web Form page will try to close itself on completion (if the Web Form is unable to close by itself, the user will be shown a message that he can close the page manually and return to your application).

  • errorRedirectUrl, same philosophy as redirectUrl except this URL will redirect the user when the Web Form runs into an unexpected error. Please remember! Users are NOT automatically redirected, unlike redirectUrl. This was done intentionally to give the user enough time to read the error message, decide and gather data they want to report, etc. Nevertheless, you can build a workflow for error conditions when the user comes back to this URL. If you don't pass an errorRedirectUrl, the Web Form will simply attempt to close the page.

  • abortRedirectUrl, same philosophy as redirectUrl except this URL will redirect the user when the Web Form is aborted by the user.

  • customerSupportUrl, to which the Web Form will display a link in case you want to offer the possibility for end-users to reach your customer support. We will display the URL in case the user cancels the workflow OR if there is an unexpected error. You can include encoded query parameters in the customerSupportUrl as well, they will be contained in the redirect. If you don't pass a customerSupportUrl, the user will be shown a message that he can close the page manually and return to your application.

For the above example, the complete URL to open in your user's browser (with an added redirectUrl and customerSupportUrl) would be:

...