Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
mailchimp

providers/mailchimp

Built-in Mailchimp integration.

default()

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

Add Mailchimp login to your page.

Setup

Callback URL

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

Configuration

import { Auth } from "@auth/core"
import Mailchimp from "@auth/core/providers/mailchimp"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Mailchimp({
      clientId: MAILCHIMP_CLIENT_ID,
      clientSecret: MAILCHIMP_CLIENT_SECRET,
    }),
  ],
})

Resources

Notes

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

💡

The Mailchimp 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

ParameterType
configOAuthUserConfig<Record<string, any>>

Returns

OAuthConfig<Record<string, any>>

Auth.js © Balázs Orbán and Team - 2024