Skip to main content

providers/freshbooks

Built-in FreshBooks integration.

default()​

default(options): OAuthConfig<Record<string, any>>

Add FreshBooks login to your page.

Setup​

Callback URL​

https://example.com/api/auth/callback/freshbooks

Configuration​

import Auth from "@auth/core"
import FreshBooks from "@auth/core/providers/freshbooks"

const request = new Request(origin)
const response = await Auth(request, {
  providers: [FreshBooks({ clientId: FRESHBOOKS_CLIENT_ID, clientSecret: FRESHBOOKS_CLIENT_SECRET })],
})

Resources​

Notes​

By default, Auth.js assumes that the FreshBooks provider is based on the OAuth 2 specification.

tip

The FreshBooks provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer

If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Parameters​

▪ options: OAuthUserConfig<Record<string, any>>

Returns​

OAuthConfig<Record<string, any>>