Configuration parameters

Learn how to configure Link.

Argyle Link provides multiple configuration options and callbacks that customize how this UI element functions within your application. The only argument that is mandatory when invoking Argyle Link is the linkKey, which can be found in the Argyle Console.

Initial configuration

For instructions on initial configuration and basic configuration examples, see:

By default, anytime Argyle Link is initialized, it is treated as a new session for a new user. To ensure your users retain their previous state in Argyle Link when it is re-initialized for them, your application must use the userToken parameter. See Returning users experience for further guidance.

Essential parameters


linkKey string uuid required

Your Link key, which can be found in the API keys section of the Argyle Console.


linkItems string optional

Use this parameter to limit the number of Link items that your users can connect to. Provide an array of Link item IDs you want Argyle Link to display on the Search screen. The order in which you list the IDs defines the order in which they are displayed on the UI.

If you provide a single Link item ID, the Search screen is skipped and the user is navigated directly to the Link item Login screen.


apiHost string optional

The API host that Argyle Link should use. Defaults to production API.


userToken string uuid optional

By default, anytime Argyle Link is initialized, Argyle will treat this as a new session for a new user. To ensure your users retain their previous state in Argyle Link when it is re-initialized for them, your application must use the userToken parameter.

UI elements parameters

You can customize Argyle Link using the Link Customizer tool or by editing Link config parameters programmatically. See Customizing Argyle Link to learn more about each of these options.


Pay Distribution parameters


payDistributionConfig string optional

Argyle Link will initiate a pay distribution change process if a pay distribution configuration is provided. Pay distribution configuration describes the desired outcome of that change. For more information on changing pay distribution, refer to the Pay Distribution Guide.


payDistributionUpdateFlow boolean optional

If payDistributionUpdateFlow is set to true and the payDistributionConfig parameter is provided, the pay distribution update flow will be initiated right after an account gets connected.

If this is set to true but the payDistributionConfig is not set, Link will not initialize properly.

The default value is false.


payDistributionItemsOnly boolean optional

When set to true, only Link items that support pay distribution will be shown. For more information on changing pay distribution, refer to the Pay Distribution Guide.

If a payDistributionConfig is provided, then only the Link items that match the parameters in the config will be shown. For example, if the payDistributionConfig allows only amount allocations and a Link item supports percent allocations only, then that Link item will not be shown.

If no payDistributionConfig is provided then all Link items that have some pay distribution support (amount and/or percent) will be shown.

The default value is false.


payDistributionAutoTrigger boolean

If set to true, the deep linked returning users are taken directly to the Pay distribution screen, if a pay distribution configuration is provided.

The default value is false.


📘

There are two additional parameters for Pay Distribution that allow you to customize the Pay Distribution Review screen title (payDistributionReviewScreenTitle) and subtitle (payDistributionReviewScreenSubtitle). See Customizing Link for more information.