...
You can forward the URL to the user as it is. Or, you can optionally append the following parameters:
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 theredirectUrl
as well, they will be contained in the redirect. If you don't pass aredirectUrl
, 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 asredirectUrl
except this URL will redirect the user when the Web Form runs into an unexpected error. Please remember! users Users are NOT automatically redirected, unlikeredirectUrl
. 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 anerrorRedirectUrl
, the Web Form will simply attempt to close the page.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 thecustomerSupportUrl
as well, they will be contained in the redirect. If you don't pass acustomerSupportUrl
, the user will be shown a message that he can close the page manually and return to your application
...
https://live.finapi.io/webForm/nEvozFaPhCXw8ZnnRBb2KJGANW6y9RjZgQtX6YRAhB_Li7TzO19jTh0wtBg9AbvblAMnJFp7DS1C0zzj746U4B7GUj4LUIyt9ZR9Sn2UoLzg5SYaEx9Ps6ax_6ImXTOB
?redirectUrl=https%3A%2F%2Fyourapp.net%2Fweb-form-redirect%3FredirectParam%3Dfoobar&customerSupportUrl=https%3A%2F%2Fyourapp.net%2Fweb-form-redirect%3FsupportParam%3Dfoobar
Note |
---|
Make sure you include the HTTP protocol in the URLs you append, otherwise the redirect to your domain will fail. |