Parameters

🚧

Already using our old iFrame version of the widget?

We are planning to deprecate the original Railz widget in the coming months. At this point, we are offering our existing clients the possibility to try out and smoothly transition to the new Railz Connect™.

All customizable options for design and functionalities are controlled by the options that are entered directly as parameters into the Railz Connect™ script.

Here's an example:

<!-- Insert this div where you want Railz Connect to be initialized -->
<div id="railz-connect"></div>


<!-- Start of Railz Connect script -->
<script src="https://connect.railz.ai/v1/railz-connect.js"></script>
<script>
  var widget = new RailzConnect();
  widget.mount({
    parentElement: document.getElementById('railz-connect'),
    widgetId: 'wid_bf51a64f-1d10-4dab-9e63-7bbbd123edd6',
    // Add additional Railz Connect configuration  paramaters here
    brandColor: 'A52EFF',
    accentColor: '3D58F3',
    language: 'en',
    redirectUrl: 'https://www.railz.ai/success',
    serviceFilterEnabled: true,
    closeEnabled: true,
    closeRedirectUrl: 'https://www.railz.ai',
    headerEnabled: true,
    removeRailzWatermark: false            
  });
</script>
<!-- End of Railz Connect script -->

All parameters and options available to you are described below:

Business Name

Parameter

Default value

Valid values

businessName

UUID

string, maxLength = 40

The unique identifier of the business as defined by you. If left as null, a unique identifier for the business will be assigned by Railz. The business name should be a maximum of 40 characters.

Language

Parameter

Default value

Valid values

language

en

en

Railz Connect™ was designed to support multiple languages. As of today, the only supported language is English.

Layout Customization

Parameter

Default value

Valid values

serviceFilterEnabled

true

true, false

closeEnabled

false

true, false

closeRedirectUrl

none-set

[string URL]

headerEnabled

true

true, false

removeRailzWatermark

false

true, false

Removing Service Filter

To hide the search bar in the service provider selection menu, you need to specify the parameter serviceFilterEnabled=false.

Enabling Close Button

To add a close button to Railz Connect™, you need to specify the parameter 'closeEnabled=true'. If closeEnabled=true, closeRedirectUrl is required, which will redirect the end-user to the provided URL when they click close.

Hiding Header

You can remove the text from the header by specifying the parameter headerEnable=false.

Removing Railz Watermark

You can remove the Railz logo watermark by setting 'removeRailzWatermark=false'.

🚧

Removing the Railz watermark is only available on paid plans.

Brand Customization

Parameter

Default value

Valid values

brandColor

38C076

Hex Color Code

accentColor

000000

Hex Color Code

Brand Color

Customize the color of links and button backgrounds by setting the brandColor parameter.

Accent Color

Customize the color of borders by setting the accentColor parameter.

❗️

Hex Color Code

You must not include the # character in the hex color code.
✅ Good usage: brandColor=38C076
❌ Bad usage: brandColor=#38C076

Redirect

Parameter

Default value

Valid values

redirectUrl

none-set

[string URL]

Railz Connect™ will redirect the end-user to a Railz branded landing page once their account was successfully connected.

We recommend setting the redirect URL to your custom landing page, which can be a Thank You page or a landing page specific to the next step in your process.


Did this page help you?