# How to Create OAuth Credentials for Pipedrive This guide will help you set up your Pipedrive OAuth app to connect with Apideck and start using the CRM API. ## Prerequisites Before you begin, make sure you have: 1. **A Pipedrive Developer Sandbox account** - You need to create a separate [Developer Sandbox account](https://developers.pipedrive.com/) to manage OAuth credentials. OAuth app management (Developer Hub) is only available in Sandbox accounts, not in production accounts. 2. An Apideck account ## 1. Enable the Pipedrive connector in Apideck 1. Navigate to the [Apideck Dashboard](https://platform.apideck.com) 2. Go to **Configuration** > **CRM** > **Pipedrive** 3. The connector will be available for configuration ## 2. Create OAuth App in Pipedrive Developer Hub ### Access Developer Hub 1. Log in to your **Developer Sandbox account** at [https://developers.pipedrive.com/](https://developers.pipedrive.com/) 2. Click your **profile picture** at the top right corner, then select **Developer Hub** ![Pipedrive - Developer Hub](https://res.cloudinary.com/apideck/image/upload/v1767104295/docs/connectors/pipedrive/developer-hub.png) ### Select App Type Select the type of app you want to create and click the **Next** button. ![Pipedrive - Select App Type](https://res.cloudinary.com/apideck/image/upload/v1767104294/docs/connectors/pipedrive/select-type-app.png) 💡 **TIP** - **Private App**: Private apps can be used in **production** and shared with selected users via an installation link. They **do not require** Pipedrive Marketplace listing or approval. - **Public App**: Public apps are only needed if you want to list your integration in the **Pipedrive Marketplace**. These apps require **Pipedrive review and approval** before being publicly available. ### Configure Basic Information Fill out basic information about your OAuth app: - **App Name**: Enter a descriptive name for your app - **Callback URL**: Enter **exactly** `https://unify.apideck.com/vault/callback` ![Pipedrive - Basic Information](https://res.cloudinary.com/apideck/image/upload/v1767104295/docs/connectors/pipedrive/add-basic-info.png) **⚠️ IMPORTANT**: The callback URL must match exactly - any variation will cause the OAuth flow to fail. ### Configure OAuth & Access Scopes 1. Navigate to the **"OAuth & Access scopes"** section 2. Select OAuth scopes that match the scopes needed to access the Pipedrive API 3. Click **"Save"** to store your preferences ![Pipedrive - OAuth Scopes](https://res.cloudinary.com/apideck/image/upload/v1767104297/docs/connectors/pipedrive/set-scopes.png) After saving, the **Client ID** and **Client Secret** will be generated. Copy these credentials - you will need them to connect your Pipedrive account to Apideck. ![Pipedrive - Copy Credentials](https://res.cloudinary.com/apideck/image/upload/v1767104291/docs/connectors/pipedrive/copy-credentials.png) ## 3. Make Your App Live All Pipedrive apps are created in **Draft** status by default. While an app is in **Draft**, it can only be authorized by users in the **same Pipedrive account** where the app was created. **External users** (your customers with their own production Pipedrive accounts) cannot authorize the app until it is set to **Live**. ### Private Apps 1. Open the **Pipedrive Developer Hub** 2. Select your app (status: **Draft**) 3. Click **"Change to Live"** ![Pipedrive - Private App Live](https://res.cloudinary.com/apideck/image/upload/v1767106865/docs/connectors/pipedrive/private-app-live.png) ### Public Apps 1. Open the **Pipedrive Developer Hub** 2. Select your app (status: **Draft**) 3. Click **"Send to review"** button ![Pipedrive - Set App to Live](https://res.cloudinary.com/apideck/image/upload/v1767104292/docs/connectors/pipedrive/set-app-to-live.png) 4. Complete the **App review information** form that appears 5. Submit the app for review 6. Once approved, your app status will change to **Live** ## 4. Configure the Pipedrive connector in Apideck 1. Navigate to the [Pipedrive connector configuration](https://platform.apideck.com/configuration/crm/pipedrive) in the Apideck Dashboard 2. Enter the following OAuth credentials: - **Client ID** - Paste the Client ID from your Pipedrive Developer Hub app - **Client Secret** - Paste the Client Secret from your Pipedrive Developer Hub app 3. Review that the scopes granted in Pipedrive match with the scopes you are requesting in Apideck 4. Click **Save settings** to save your credentials ![Apideck - Configure OAuth credentials](https://res.cloudinary.com/apideck/image/upload/v1767104292/docs/connectors/pipedrive/connector-configuration.png) ## 5. Test Your Connection You can test your Pipedrive connector by clicking **Test Vault** in the Apideck dashboard. - Click **Authorize** to start the OAuth flow ![Pipedrive - Unauthorized Connection](https://res.cloudinary.com/apideck/image/upload/v1767104293/docs/connectors/pipedrive/unauthorized-connection.png) - Grant permissions to your app - After successful authorization, the connection will show as **Connected** ![Pipedrive - Authorized Connection](https://res.cloudinary.com/apideck/image/upload/v1767104291/docs/connectors/pipedrive/authorized-connection.png) ## Marketplace Installation If you want your app to be installed from the Pipedrive Marketplace, you'll need to use a custom callback URL instead of the standard Apideck callback URL. ### Setup Custom Callback Endpoint 1. Create an endpoint in your application that will: - Accept the OAuth callback from Pipedrive - Generate a state parameter using Apideck's [createCallbackState API](https://developers.apideck.com/apis/vault/reference#tag/Connections/operation/createCallbackState) - Forward the request to `https://unify.apideck.com/vault/callback` with: - The `code` parameter received from Pipedrive - The generated `state` parameter Example Node.js implementation: ```javascript app.get('/oauth/pipedrive/callback', async (req, res) => { const pipedriveCode = req.query.code // Generate Apideck state const stateResponse = await fetch( 'https://unify.apideck.com/vault/connections/crm/pipedrive/callback-state', { method: 'POST', headers: { 'Content-Type': 'application/json', Authorization: `Bearer ${APIDECK_API_KEY}`, 'x-apideck-app-id': '', 'x-apideck-consumer-id': '' // If it doesn't exist, a new consumer will be created }, body: JSON.stringify({ redirect_uri: 'https://unify.apideck.com/vault/callback' // Or the redirect uri you want your user to be at the end of the oauth flow. Please request Apideck to register this redirect URI for your application }) } ) const { state } = await stateResponse.json() // Redirect to Apideck with code and state const apideckUrl = new URL('https://unify.apideck.com/vault/callback') apideckUrl.searchParams.append('code', pipedriveCode) apideckUrl.searchParams.append('state', state) res.redirect(apideckUrl.toString()) }) ``` 2. Configure this endpoint URL in Pipedrive: - In the **Basic Information** section, set the **Callback URL** to your custom endpoint (e.g. `https://your-domain.com/oauth/pipedrive/callback`) - Make sure your domain is accessible via HTTPS - Test the OAuth flow thoroughly before submitting to the marketplace ## Marketplace Listing If you want to list your app in the Pipedrive Marketplace, navigate to the **Marketplace listing** section and fill in information about your app listing. ### General Info In the **General info** section, provide: - **Description**: Provide a brief description of your app - **Logo**: Upload a logo for your app - **Support contact info**: Add support contact information ![Pipedrive - General Info](https://res.cloudinary.com/apideck/image/upload/v1767106225/docs/connectors/pipedrive/general-info-app.png) **Note**: Marketplace listing is optional. You can skip this step if you only need to use the app for your own integrations and don't plan to publish it to the marketplace. However, if you're creating a Public App, you'll still need to complete the App review info form to set your app to Live status (see [Make Your App Live](#3-make-your-app-live) section above). More details on the configuration of an OAuth Pipedrive app can be found in the [Pipedrive documentation](https://pipedrive.readme.io/docs/marketplace-creating-a-proper-app). ## Pipedrive Webhook Registration ### Register a Pipedrive webhook in Unify 1. Go to the Apideck dashboard > Configuration > CRM > [Pipedrive](https://platform.apideck.com/configuration/crm/pipedrive) 2. On the Unify [Pipedrive connector settings](https://platform.apideck.com/configuration/crm/pipedrive), at the bottom, you can find the **Webhook Execute URL** ![Apideck - Pipedrive connector](https://res.cloudinary.com/apideck/image/upload/v1767104293/docs/connectors/pipedrive/webhooks-configuration.png) **💡 IMPORTANT**: Copy the full "Webhook execute URL" since you need this URL to register it in Pipedrive ### Create a webhook subscription in Pipedrive 1. Sign in to your Pipedrive account 2. Click your **profile picture** at the top right corner, then select **Tools and Apps** ![Pipedrive - Tools and Apps](https://res.cloudinary.com/apideck/image/upload/v1767107932/docs/connectors/pipedrive/tools-and-apps.png) 3. Click on **Webhooks** in the Tools and Apps menu 4. Click on the **"New Webhook"** button 5. In the "Create New Webhook" modal: - **Endpoint URL**: Enter the **Webhook Execute URL** from Apideck (copied in the previous step) - **Events**: Select the events that the webhook should be triggered for from the dropdown menu 6. Click **Save** to register the webhook ![Pipedrive - Configure Webhooks](https://res.cloudinary.com/apideck/image/upload/v1767107933/docs/connectors/pipedrive/configure-webhooks.png) After the webhook has been registered, you can view and manage it from the "Webhooks" page in the Pipedrive settings. ### Subscribe to Unify events After you have completed the above steps, you can subscribe your application to Unify Events. - Go to the Apideck dashboard > Webhooks - Click on **Add webhook** - Add your Delivery Endpoint URL - Select the Unified API (CRM, Accounting etc.) - Select the events - Add a description and click on **Create** ![Apideck - Webhook subscription](https://res.cloudinary.com/apideck/image/upload/v1767110006/docs/connectors/pipedrive/create-webhooks-apideck.png) Now your app and webhooks are configured! 🎉