Skip to content

EXP-2618 Document the Link support contact options and recent SDK additions #1896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brucepouncey merged 5 commits into from
Nov 2, 2026
Merged

EXP-2618 Document the Link support contact options and recent SDK additions #1896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba97ab1
EXP-2618 Document supportContactEmail Link SDK option
rodages Oct 22, 2026
9209720
EXP-2618 Document the support contact email Link setting
rodages Oct 23, 2026
6ea4153
EXP-2618 Match the Portal's Link settings and document the scheduling…
rodages Oct 30, 2026
621854b
EXP-2618 Document enableManageConnections, hideBorder and isReconnection
rodages Oct 30, 2026
61f85c5
EXP-2618 Correct nonModal, onConnectionStarted and manage connections…
rodages Oct 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/auth-flow/authorize-embedded-link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ To display the origins you previously registered for your instance, use the [Get

You can add custom logic into our SDK by using callback functions to complete an action. Use the properties below to pass the callback functions into the SDK component:

| Property | Description | Arguments |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `onConnectionStarted` | Called when the user selects their integration. A connection is successfully created in a `pending` state. | A `connection` object containing the following properties: <ul><li>`connectionId` - unique identifier of the connection</li><li>`integrationId` - unique identifier of the integration</li><li>`sourceId` - unique identifier of the source type</li><li>`sourceType` - value indicating the information source type (`Unknown`, `Accounting`, `Banking`, `BankFeed`, `Commerce`, `Expense`, or `Other`)</li><li>`integrationKey` - 4-character value that identifies the integration software in Codat</li><li>`platformName` - name of the integration software</li></ul> |
| `onConnection` | Called when a connection is successfully authorized and moved out of a `pending` state or files are uploaded. | A `connection` object containing the following properties: <ul><li>`connectionId` - unique identifier of the connection</li><li>`integrationId` - unique identifier of the integration</li><li>`sourceId` - unique identifier of the source type</li><li>`sourceType` - value indicating the information source type (`Unknown`, `Accounting`, `Banking`, `BankFeed`, `Commerce`, `Expense`, or `Other`)</li><li>`integrationKey` - 4-character value that identifies the integration software in Codat</li><li>`platformName` - name of the integration software</li></ul> |
| `onConsent` | Called when the user consents to the terms of use of their data. | A `text` object containing a Markdown representation of all text on the consent screen. |
| `onFinish` | Called when the user completes all required steps of the connection flow and clicks the "Complete" button.<br/> We recommend unmounting the `CodatLink` component in this callback. In the React example above, we call `setModalOpen(false)` to do this. | |
| `onClose` | Called when the user clicks the "X" ("Close") button of the connection flow. <br/> We recommend removing the `CodatLink` component in this callback. In the React example above, we call `setModalOpen(false)` to do this. | |
| `onError` | Called when an error occurs in the connection flow, returning the error information. <br/><br/> **Log these errors.** We also recommend unmounting the `CodatLink` component in production if the `userRecoverable` parameter is `false`. | An `error` object containing the following properties: <ul><li>`correlationId` - internal identifier used to track errors within Codat</li><li>`message` - descriptive error response</li><li>`errorCode` - numerical code of the error</li><li>`userRecoverable` - boolean value indicating whether the error can be resolved by the user.</li></ul> `correlationId`, `message`, and `errorCode` are optional and may not be available in all errors. |
| Property | Description | Arguments |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `onConnectionStarted` | Called when a connection is created in a `pending` state after the user consents, or when the user starts reconnecting an existing connection. Not called for file uploads. | A `connection` object containing the following properties: <ul><li>`connectionId` - unique identifier of the connection</li><li>`integrationId` - unique identifier of the integration</li><li>`sourceId` - unique identifier of the source type</li><li>`sourceType` - value indicating the information source type (`Unknown`, `Accounting`, `Banking`, `BankFeed`, `Commerce`, `Expense`, or `Other`)</li><li>`integrationKey` - 4-character value that identifies the integration software in Codat</li><li>`platformName` - name of the integration software</li><li>`isReconnection` - `true` when the user is reconnecting an existing connection, `false` for a first-time connection</li></ul> |
| `onConnection` | Called when a connection is successfully authorized or reconnected and moved out of a `pending` state, or when files are uploaded. | A `connection` object containing the following properties: <ul><li>`connectionId` - unique identifier of the connection</li><li>`integrationId` - unique identifier of the integration</li><li>`sourceId` - unique identifier of the source type</li><li>`sourceType` - value indicating the information source type (`Unknown`, `Accounting`, `Banking`, `BankFeed`, `Commerce`, `Expense`, or `Other`)</li><li>`integrationKey` - 4-character value that identifies the integration software in Codat</li><li>`platformName` - name of the integration software</li><li>`isReconnection` - `true` when the user is reconnecting an existing connection, `false` for a first-time connection or a file upload</li></ul> |
| `onConsent` | Called when the user consents to the terms of use of their data. | A `text` object containing a Markdown representation of all text on the consent screen. |
| `onFinish` | Called when the user completes all required steps of the connection flow and clicks the "Complete" button.<br/> We recommend unmounting the `CodatLink` component in this callback. In the React example above, we call `setModalOpen(false)` to do this. | |
| `onClose` | Called when the user clicks the "X" ("Close") button of the connection flow. <br/> We recommend removing the `CodatLink` component in this callback. In the React example above, we call `setModalOpen(false)` to do this. | |
| `onError` | Called when an error occurs in the connection flow, returning the error information. <br/><br/> **Log these errors.** We also recommend unmounting the `CodatLink` component in production if the `userRecoverable` parameter is `false`. | An `error` object containing the following properties: <ul><li>`correlationId` - internal identifier used to track errors within Codat</li><li>`message` - descriptive error response</li><li>`errorCode` - numerical code of the error</li><li>`userRecoverable` - boolean value indicating whether the error can be resolved by the user.</li></ul> `correlationId`, `message`, and `errorCode` are optional and may not be available in all errors. |

## Customize Link

Expand Down
12 changes: 12 additions & 0 deletions docs/auth-flow/customize/customize-link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,18 @@ This setting is only relevant for integrations that allow their users to operate
alt="A comparison screenshot that shows the difference of the connection flow with the multi-entity setting toggled off and on. Without the setting, the screen displays a dropdown list of multiple entities found in a NetSuite account, and it's only possible to select one entity. With the setting toggled on, the screen displays a checklist of multiple entities found in a NetSuite account and all entities are selected."
/>

#### File upload support email

Provide the email address your customers can contact when their files fail to submit in the [intelligent file upload](/spend-insights/resources/link-file) journey. Link always shows a message suggesting they contact you for support. If you set an email address, Link also displays a **Contact bank** button that opens a new email to that address. Use a single valid email address, or leave the field empty to show only the message.

#### File upload scheduling link

Provide a scheduling link, such as a Calendly page, that your customers can use to book a call for help exporting files from their software. When set, the intelligent file upload steps display a **Need assistance? Contact us** footer, and **Contact us** opens the link in a new tab. Use an `http` or `https` URL, or leave the field empty to hide the footer.

#### Manage connections

Let your customers review and manage their existing connections within Link. When enabled, companies that have already connected at least one platform see the manage connections screen when they open Link. The screen is only shown when Link is initialized with an `accessToken` for the company. You can also customize the title and subtitle of this screen.

#### Mobile support warning

Let your users know that some integrations are not optimized or will not connect via mobile when accessing the connection journey on mobile.
Expand Down
Loading
Loading