diff --git a/docs/auth-flow/authorize-embedded-link.md b/docs/auth-flow/authorize-embedded-link.md index 0166741a30..a85e19c921 100644 --- a/docs/auth-flow/authorize-embedded-link.md +++ b/docs/auth-flow/authorize-embedded-link.md @@ -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: | -| `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: | -| `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.
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.
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.

**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: `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: | +| `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: | +| `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.
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.
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.

**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: `correlationId`, `message`, and `errorCode` are optional and may not be available in all errors. | ## Customize Link diff --git a/docs/auth-flow/customize/customize-link.md b/docs/auth-flow/customize/customize-link.md index a077108bb7..264f94b239 100644 --- a/docs/auth-flow/customize/customize-link.md +++ b/docs/auth-flow/customize/customize-link.md @@ -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. diff --git a/docs/auth-flow/customize/sdk-customize-code.md b/docs/auth-flow/customize/sdk-customize-code.md index 24a766a7f9..f17c599d4b 100644 --- a/docs/auth-flow/customize/sdk-customize-code.md +++ b/docs/auth-flow/customize/sdk-customize-code.md @@ -20,7 +20,7 @@ function AuthFlow() { const config = { companyId: "e0e0462f-d7f3-456f-b3e9-0b40afe0245e", options: { - nonModal: false, + hideBorder: false, showLandingPage: true, showSandboxIntegrations: true, //theme: {...}, @@ -30,6 +30,9 @@ function AuthFlow() { //text: {...}, enableAdditionalConsent: true, enableMultiEntityLinking: true, + enableManageConnections: true, + supportContactEmail: "support@example.com", + codatSupportBookingUrl: "https://calendly.com/your-team/support", //nonce: "r4nd0mB4se64Val==", }, }; @@ -60,7 +63,7 @@ As the `options` object overrides the Link settings set in the Portal, this may onClose={onClose} onFinish={onFinish} options={{ - nonModal: true, + hideBorder: true, showLandingPage: true, showSandboxIntegrations: true, theme: {...}, @@ -72,6 +75,9 @@ As the `options` object overrides the Link settings set in the Portal, this may text: {...}, enableAdditionalConsent: true, enableMultiEntityLinking: true, + enableManageConnections: true, + supportContactEmail: "support@example.com", + codatSupportBookingUrl: "https://calendly.com/your-team/support", nonce: "r4nd0mB4se64Val==", }} /> @@ -79,26 +85,32 @@ As the `options` object overrides the Link settings set in the Portal, this may The `options` prop is optional and accepts an object containing the following optional properties: -| Property | Description | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `nonModal` | Determines whether Link uses non-modal styling, removing the border and close button. | -| `showLandingPage` | Determines whether the user sees an extra landing page at the start of Link. | -| `showSandboxIntegrations` | Controls whether integrations that only connect Sandbox data appear for selection. | -| `theme` | Contains options that control the visual appearance of the Link flow. | -| `sourceTypes` | Controls which data source types (Accounting, Commerce, Banking, and Business Documents) the user can connect or upload files for. | -| `text` | Contains options that control what text the user sees. Supports Markdown. | -| `enableAdditionalConsent` | Determines whether the user sees an additional consent journey for further use cases. | -| `enableMultiEntityLinking` | Allows users to authorize to multiple companies within a single accounting platform in one go for compatible integrations. | -| `nonce` | A CSP nonce to apply to all `