Link SDK Errors
Link SDKs offer an onError callback so you can handle different error states of the Link Modal. Alternatively, the onEvent callback also fires error events as well.
Looking for a different category of errors?
Pinwheel's system also communicates API Errors and Job Errors.
The onError callback will be triggered for Link Modal errors as well as Job Errors. If an error occurred before closing the modal, Link's onExit callback is called with an error object as well.
Users may be able to proceed after
erroreventsErrors surfaced via the
errorevent do not necessarily mean the user can no longer continue to successfully complete the flow. For example, the error with codeinvalidCredentialsfires when a user inputs invalid credentials, however, the user can proceed despite this error.
Link error types and codes are safe for developer use, whereas error messages are liable to change.
There are three different Link error types:
| Error Type | Description |
|---|---|
networkError | The user's device is offline. |
clientError | There is a problem with the SDK integration. |
invalidLinkToken | The Link token is invalid. |
Specific error codes include:
| type | code | description | message |
|---|---|---|---|
networkError | networkError | Thrown when the user's device is offline, or when there is an issue communicating with the server. | Uh oh, looks like your device is offline. Please try again later. |
clientError | clientError | This error is thrown when the client modal is in an erroneous state | Uh oh, looks like we're having trouble getting you connected. Please try again later. |
clientError | connectionRateLimited | This error is thrown when a client is rate limited | Uh oh, looks like we're having trouble getting you connected. Please try again later. |
systemError | systemError | An unhandled error when a payroll integration behaves in an unexpected manner. These errors are fixed such that subsequent users do not trigger them | Uh oh, looks like we're having trouble getting you connected. Please try again later. |
invalidLinkToken | usedLinkToken | The Link token has already been used | Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later. |
invalidLinkToken | invalidLinkTokenSignature | The Link token signature is invalid | Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later. |
invalidLinkToken | invalidLinkToken | The Link token is invalid | Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later. |
invalidLinkToken | expiredLinkToken | The Link token has expired | Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later. |
Please contact [email protected] for access to our Developer Dashboard.
Updated almost 2 years ago