Build Your Integration

Handle Authentication

Zapier Example OAuth Authentication

Many Zapier integrations use OAuth2 authentication to connect user accounts, including Zapier’s built-in GitHub integration

The first thing to set up is authentication. Your integration defines how Zapier’s platform authenticates with the API and what data needs to be collected from users to allow access to their accounts. Zapier supports most popular authentication schemes, including basic auth with username and password, API key auth, digest, session, and OAuth v2.

Whenever someone uses your integration in a Zap, they’ll first select your app, then will connect their account. That’s where the authentication flow comes in. Zapier shows a popup window where users login and select their account with OAuth2, or where they can enter account details with basic auth.

1. Select Your Authentication Scheme

Zapier Visual Builder select auth

Zapier supports a wide range of authentication schemes—select the best one for your app

We’ll use basic auth in this sample GitHub integration to keep things simple. Click the Authentication tab in Zapier visual builder, then select Basic Auth from the menu. Zapier will create a form with input fields to collect the username and password automatically.

If you want to use OAuth or another authentication scheme, check our auth docs for more details and use them instead of the steps below.

2. Add Authentication Details

Zapier Visual Builder Basic Auth

Zapier automatically creates a form for Basic Auth—all you need to add is a test API call to ensure those credentials work

With Basic authentication, you only specify an API endpoint to test the user’s credentials. To do that, add GitHub’s user API call  to the Test field.

Example connection label

Add a connection label, and users’ accounts in Zapier will be personalized to easily distinguish between multiple accounts.

You can also add details to the account. Whenever a new account is authenticated with Zapier, Zapier adds a Connection Label so users can identify accounts and add multiple accounts if desired. Customize this label with output fields from the API call (learn more in our connection label docs).

For GitHub, add {{bundle.authData.username}} to the Connection Label to include users’ GitHub username along with the app name that Zapier automatically includes.

3. Test The Authentication

Basic Auth example

Basic Auth in Zapier shows a form where users enter their username and password—unlike OAuth2 above where Zapier sends users to your site to authenticate

Then test the authentication. Click Connect an Account, and enter your GitHub username and password or personal access token. You can now use this GitHub account to test triggers and actions as you build them into your integration.

When others use your integration, they’ll see a similar login flow to connect their GitHub account to Zapier—only there, the popup window will open from the Zap editor.

Need help? Tell us about your problem and we’ll connect you with the right resource or contact support.