Set up Violet Connect

The channel will be responsible for providing the following values that will populate and configure the onboarding experience. In these values can be configured by you in the Channel dashboard. There may be additional configuration options that will be discussed during your integration.

  • Custom Path (ex.
  • App Name
  • App Description
  • Square Logo or Icon
  • Supported Commerce Platforms List
  • More Info URL
  • Redirect URL (where the merchant should return to upon success)

Once these values have been provided to Violet they will be applied to your Violet app’s configuration. If you have these values ready you can configure them on

Connecting Merchants

Once setup you can go to your selected custom path then go through the setup flow.

Redirect URL

The merchant will redirect to this URL after completion of the Violet Connect flow. You can pass in custom state information as documented below. Violet will append a query parameter, merchant_id to the redirect URL. This is the merchant_id stored in Violet and can be used by you for subsequent calls.

Custom State

Using the state query string parameter you can pass a value into Violet Connect by appending that to your Violet Connect URL, for example The passed in state will be returned to you when the merchant completes the onboarding process.

NOTE: state should be set when linking merchants to Violet Connect, do not add the  query parameter in the Violet Channel Dashboard

As a more detailed example, if your base Violet Connect URL was and you send the merchant to With your base redirect URL set as after completion of Violet Connect the merchant will redirect to containing the same state or value that was passed into Violet Connect to start.

State in Webhooks

The above mentioned state will also come across in a x-violet-connect-state header on the MERCHANT_CONNECTED webhook that is fired when a merchant completes a connection. This will give you additional options as to what and how you use this state field.

When testing the merchant onboarding process in Sandbox, do not use an email address that you later plan on using for a developer type account. When signing up as a developer we must create accounts in both the Production and Sandbox environments. If you use the email address with a Sandbox merchant it will become reserved in Sandbox and we will not be able to complete the creation of your developer account if you try to use it for that purpose in the future.