Merge pull request #1294 from automatisch/pipedrive-integration

feat(pipedrive): add new deals trigger

packages/backend/src/apps/pipedrive/assets/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" width="32" height="32" viewBox="0 0 32 32" fill="#FFFFFF" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_503_588)" fill="#017737"><path d="M32 16C32 24.8366 24.8366 32 16 32C7.16344 32 0 24.8366 0 16C0 7.16344 7.16344 0 16 0C24.8366 0 32 7.16344 32 16Z" fill="#017737"></path><path d="M24.9842 13.4564C24.9842 17.8851 22.1247 20.914 18.036 20.914C16.0923 20.914 14.4903 20.1136 13.8906 19.1134L13.9189 20.142V26.4847H9.74512V10.0846C9.74512 9.85644 9.68836 9.79843 9.4304 9.79843H8V6.31321H11.4889C13.0896 6.31321 13.4907 7.68461 13.6042 8.28525C14.2337 7.22834 15.8911 6 18.2359 6C22.2679 5.99871 24.9842 8.99802 24.9842 13.4564ZM20.724 13.4847C20.724 11.1131 19.1801 9.48523 17.2351 9.48523C15.6344 9.48523 13.8325 10.5421 13.8325 13.5144C13.8325 15.4568 14.9186 17.4855 17.1783 17.4855C18.837 17.4842 20.724 16.2843 20.724 13.4847Z" fill="#FFFFFF"></path></g></svg>

packages/backend/src/apps/pipedrive/auth/generate-auth-url.ts

@@ -0,0 +1,19 @@
+import { IField, IGlobalVariable } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+
+export default async function generateAuthUrl($: IGlobalVariable) {
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field: IField) => field.key == 'oAuthRedirectUrl'
+  );
+  const redirectUri = oauthRedirectUrlField.value as string;
+  const searchParams = new URLSearchParams({
+    client_id: $.auth.data.clientId as string,
+    redirect_uri: redirectUri,
+  });
+
+  const url = `https://oauth.pipedrive.com/oauth/authorize?${searchParams.toString()}`;
+
+  await $.auth.set({
+    url,
+  });
+}

packages/backend/src/apps/pipedrive/auth/index.ts

@@ -0,0 +1,48 @@
+import generateAuthUrl from './generate-auth-url';
+import verifyCredentials from './verify-credentials';
+import refreshToken from './refresh-token';
+import isStillVerified from './is-still-verified';
+
+export default {
+  fields: [
+    {
+      key: 'oAuthRedirectUrl',
+      label: 'OAuth Redirect URL',
+      type: 'string' as const,
+      required: true,
+      readOnly: true,
+      value: '{WEB_APP_URL}/app/pipedrive/connections/add',
+      placeholder: null,
+      description:
+        'When asked to input a redirect URL in Pipedrive, enter the URL above.',
+      clickToCopy: true,
+    },
+    {
+      key: 'clientId',
+      label: 'Client ID',
+      type: 'string' as const,
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+    {
+      key: 'clientSecret',
+      label: 'Client Secret',
+      type: 'string' as const,
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+  ],
+
+  generateAuthUrl,
+  verifyCredentials,
+  isStillVerified,
+  refreshToken,
+};

packages/backend/src/apps/pipedrive/auth/is-still-verified.ts

@@ -0,0 +1,9 @@
+import { IGlobalVariable } from '@automatisch/types';
+import getCurrentUser from '../common/get-current-user';
+
+const isStillVerified = async ($: IGlobalVariable) => {
+  const currentUser = await getCurrentUser($);
+  return !!currentUser;
+};
+
+export default isStillVerified;

packages/backend/src/apps/pipedrive/auth/refresh-token.ts

@@ -0,0 +1,33 @@
+import { URLSearchParams } from 'node:url';
+import { IGlobalVariable } from '@automatisch/types';
+
+const refreshToken = async ($: IGlobalVariable) => {
+  const params = new URLSearchParams({
+    grant_type: 'refresh_token',
+    refresh_token: $.auth.data.refreshToken as string,
+  });
+
+  const headers = {
+    Authorization: `Basic ${Buffer.from(
+      $.auth.data.clientId + ':' + $.auth.data.clientSecret
+    ).toString('base64')}`,
+    'Content-Type': 'application/x-www-form-urlencoded',
+  };
+
+  const response = await $.http.post(
+    'https://oauth.pipedrive.com/oauth/token',
+    params.toString(),
+    {
+      headers,
+    }
+  );
+
+  await $.auth.set({
+    accessToken: response.data.access_token,
+    refreshToken: response.data.refresh_token,
+    tokenType: response.data.token_type,
+    expiresIn: response.data.expires_in,
+  });
+};
+
+export default refreshToken;

packages/backend/src/apps/pipedrive/auth/verify-credentials.ts

@@ -0,0 +1,59 @@
+import { IField, IGlobalVariable } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+import getCurrentUser from '../common/get-current-user';
+
+const verifyCredentials = async ($: IGlobalVariable) => {
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field: IField) => field.key == 'oAuthRedirectUrl'
+  );
+  const redirectUri = oauthRedirectUrlField.value as string;
+  const params = new URLSearchParams({
+    grant_type: 'authorization_code',
+    code: $.auth.data.code as string,
+    redirect_uri: redirectUri,
+  });
+
+  const headers = {
+    Authorization: `Basic ${Buffer.from(
+      $.auth.data.clientId + ':' + $.auth.data.clientSecret
+    ).toString('base64')}`,
+    'Content-Type': 'application/x-www-form-urlencoded',
+  };
+
+  const response = await $.http.post(
+    `https://oauth.pipedrive.com/oauth/token`,
+    params.toString(),
+    { headers }
+  );
+
+  const {
+    access_token: accessToken,
+    api_domain: apiDomain,
+    expires_in: expiresIn,
+    refresh_token: refreshToken,
+    scope: scope,
+    token_type: tokenType,
+  } = response.data;
+
+  await $.auth.set({
+    accessToken,
+    apiDomain,
+    expiresIn,
+    refreshToken,
+    scope,
+    tokenType,
+  });
+
+  const user = await getCurrentUser($);
+
+  const screenName = [user.name, user.company_domain]
+    .filter(Boolean)
+    .join(' @ ');
+
+  await $.auth.set({
+    userId: user.id,
+    screenName,
+  });
+};
+
+export default verifyCredentials;

packages/backend/src/apps/pipedrive/common/add-auth-header.ts

@@ -0,0 +1,11 @@
+import { TBeforeRequest } from '@automatisch/types';
+
+const addAuthHeader: TBeforeRequest = ($, requestConfig) => {
+  if ($.auth.data?.accessToken) {
+    requestConfig.headers.Authorization = `${$.auth.data.tokenType} ${$.auth.data.accessToken}`;
+  }
+
+  return requestConfig;
+};
+
+export default addAuthHeader;

packages/backend/src/apps/pipedrive/common/get-current-user.ts

@@ -0,0 +1,10 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+
+const getCurrentUser = async ($: IGlobalVariable): Promise<IJSONObject> => {
+  const response = await $.http.get(`${$.auth.data.apiDomain}/api/v1/users/me`);
+  const currentUser = response.data.data;
+
+  return currentUser;
+};
+
+export default getCurrentUser;

packages/backend/src/apps/pipedrive/index.ts

@@ -0,0 +1,18 @@
+import defineApp from '../../helpers/define-app';
+import addAuthHeader from './common/add-auth-header';
+import auth from './auth';
+import triggers from './triggers';
+
+export default defineApp({
+  name: 'Pipedrive',
+  key: 'pipedrive',
+  baseUrl: '',
+  apiBaseUrl: '',
+  iconUrl: '{BASE_URL}/apps/pipedrive/assets/favicon.svg',
+  authDocUrl: 'https://automatisch.io/docs/apps/pipedrive/connection',
+  primaryColor: 'FFFFFF',
+  supportsConnections: true,
+  beforeRequest: [addAuthHeader],
+  auth,
+  triggers,
+});

packages/backend/src/apps/pipedrive/triggers/index.ts

@@ -0,0 +1,3 @@
+import newDeals from './new-deals';
+
+export default [newDeals];

packages/backend/src/apps/pipedrive/triggers/new-deals/index.ts

@@ -0,0 +1,56 @@
+import defineTrigger from '../../../../helpers/define-trigger';
+
+type Payload = {
+  start: number;
+  limit: number;
+  sort: string;
+};
+
+type ResponseData = {
+  data: {
+    id: number;
+  }[];
+  additional_data: {
+    pagination: {
+      next_start: number;
+    };
+  };
+};
+
+export default defineTrigger({
+  name: 'New deals',
+  key: 'newDeals',
+  pollInterval: 15,
+  description: 'Triggers when a new deal is created.',
+  arguments: [],
+
+  async run($) {
+    const params: Payload = {
+      start: 0,
+      limit: 100,
+      sort: 'add_time DESC',
+    };
+
+    do {
+      const { data } = await $.http.get<ResponseData>(
+        `${$.auth.data.apiDomain}/api/v1/deals`,
+        { params }
+      );
+
+      if (!data?.data?.length) {
+        return;
+      }
+
+      params.start = data.additional_data?.pagination?.next_start;
+
+      for (const deal of data.data) {
+        $.pushTriggerItem({
+          raw: deal,
+          meta: {
+            internalId: deal.id.toString(),
+          },
+        });
+      }
+    } while (params.start);
+  },
+});

packages/docs/pages/.vitepress/config.js

@@ -215,6 +215,15 @@ export default defineConfig({
             { text: 'Connection', link: '/apps/openai/connection' },
           ],
         },
+        {
+          text: 'Pipedrive',
+          collapsible: true,
+          collapsed: true,
+          items: [
+            { text: 'Triggers', link: '/apps/pipedrive/triggers' },
+            { text: 'Connection', link: '/apps/pipedrive/connection' },
+          ],
+        },
         {
           text: 'PostgreSQL',
           collapsible: true,

packages/docs/pages/apps/pipedrive/connection.md

@@ -0,0 +1,17 @@
+# Pipedrive
+
+:::info
+This page explains the steps you need to follow to set up the Pipedrive
+connection in Automatisch. If any of the steps are outdated, please let us know!
+:::
+
+1. Go to [Pipedrive developers page](https://developers.pipedrive.com/).
+2. Sign up for a **Sandbox account** in order to create an app.
+3. Click create an app button and then choose **Create private app** option.
+4. Write any app name to be displayed in Automatisch.
+5. Copy **OAuth Redirect URL** from Automatisch to **Callback URL** field, and click on the **Save** button.
+6. Check all options in **OAuth & Access scopes** with full access.
+7. Click on the **Save** button.
+8. Copy the **Client ID** value to the `Client ID` field on Automatisch.
+9. Copy the **Client Secret** value to the `Client Secret` field on Automatisch.
+10. Start using Pipedrive integration with Automatisch!

packages/docs/pages/apps/pipedrive/triggers.md

@@ -0,0 +1,12 @@
+---
+favicon: /favicons/pipedrive.svg
+items:
+  - name: New deals
+    desc: Triggers when a new deal is created.
+---
+
+<script setup>
+  import CustomListing from '../../components/CustomListing.vue'
+</script>
+
+<CustomListing />

packages/docs/pages/guide/available-apps.md

@@ -22,6 +22,7 @@ The following integrations are currently supported by Automatisch.
 - [Ntfy](/apps/ntfy/actions)
 - [Odoo](/apps/odoo/actions)
 - [OpenAI](/apps/openai/actions)
+- [Pipedrive](/apps/pipedrive/triggers)
 - [PostgreSQL](/apps/postgresql/actions)
 - [RSS](/apps/rss/triggers)
 - [Salesforce](/apps/salesforce/triggers)

packages/docs/pages/public/favicons/pipedrive.svg

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" width="32" height="32" viewBox="0 0 32 32" fill="#FFFFFF" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_503_588)" fill="#017737"><path d="M32 16C32 24.8366 24.8366 32 16 32C7.16344 32 0 24.8366 0 16C0 7.16344 7.16344 0 16 0C24.8366 0 32 7.16344 32 16Z" fill="#017737"></path><path d="M24.9842 13.4564C24.9842 17.8851 22.1247 20.914 18.036 20.914C16.0923 20.914 14.4903 20.1136 13.8906 19.1134L13.9189 20.142V26.4847H9.74512V10.0846C9.74512 9.85644 9.68836 9.79843 9.4304 9.79843H8V6.31321H11.4889C13.0896 6.31321 13.4907 7.68461 13.6042 8.28525C14.2337 7.22834 15.8911 6 18.2359 6C22.2679 5.99871 24.9842 8.99802 24.9842 13.4564ZM20.724 13.4847C20.724 11.1131 19.1801 9.48523 17.2351 9.48523C15.6344 9.48523 13.8325 10.5421 13.8325 13.5144C13.8325 15.4568 14.9186 17.4855 17.1783 17.4855C18.837 17.4842 20.724 16.2843 20.724 13.4847Z" fill="#FFFFFF"></path></g></svg>