✨ Add Pipedrive-Trigger-Node

packages/nodes-base/nodes/Pipedrive/PipedriveTrigger.node.ts

@@ -0,0 +1,316 @@
+import {
+	IHookFunctions,
+	IWebhookFunctions,
+} from 'n8n-core';
+
+import {
+	INodeTypeDescription,
+	INodeType,
+	IWebhookResonseData,
+} from 'n8n-workflow';
+
+import {
+	pipedriveApiRequest,
+} from './GenericFunctions';
+
+import * as basicAuth from 'basic-auth';
+import { Response } from 'express';
+
+
+function authorizationError(resp: Response, realm: string, responseCode: number, message?: string) {
+	if (message === undefined) {
+		message = 'Authorization problem!';
+		if (responseCode === 401) {
+			message = 'Authorization is required!';
+		} else if (responseCode === 403) {
+			message = 'Authorization data is wrong!';
+		}
+	}
+
+	resp.writeHead(responseCode, { 'WWW-Authenticate': `Basic realm="${realm}"` });
+	resp.end(message);
+	return {
+		noWebhookResponse: true,
+	};
+}
+
+export class PipedriveTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Pipedrive Trigger',
+		name: 'pipedriveTrigger',
+		icon: 'file:pipedrive.png',
+		group: ['trigger'],
+		version: 1,
+		description: 'Starts the workflow when Pipedrive events occure.',
+		defaults: {
+			name: 'Pipedrive Trigger',
+			color: '#559922',
+		},
+		inputs: [],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'pipedriveApi',
+				required: true,
+			},
+			{
+				name: 'httpBasicAuth',
+				required: true,
+				displayOptions: {
+					show: {
+						authentication: [
+							'basicAuth',
+						],
+					},
+				},
+			},
+		],
+		webhooks: [
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				reponseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			{
+				displayName: 'Authentication',
+				name: 'authentication',
+				type: 'options',
+				options: [
+					{
+						name: 'Basic Auth',
+						value: 'basicAuth'
+					},
+					{
+						name: 'None',
+						value: 'none'
+					},
+				],
+				default: 'none',
+				description: 'If authentication should be activated for the webhook (makes it more scure).',
+			},
+			{
+				displayName: 'Action',
+				name: 'action',
+				type: 'options',
+				options: [
+					{
+						name: 'All',
+						value: '*',
+						description: 'Any change',
+					},
+					{
+						name: 'Added',
+						value: 'added',
+						description: 'Data got added'
+					},
+					{
+						name: 'Deleted',
+						value: 'deleted',
+						description: 'Data got deleted'
+					},
+					{
+						name: 'Merged',
+						value: 'merged',
+						description: 'Data got merged'
+					},
+					{
+						name: 'Updated',
+						value: 'updated',
+						description: 'Data got updated'
+					},
+				],
+				default: '*',
+				description: 'Type of action to receive notifications about.',
+			},
+			{
+				displayName: 'Object',
+				name: 'object',
+				type: 'options',
+				options: [
+					{
+						name: 'All',
+						value: '*',
+					},
+					{
+						name: 'Activity',
+						value: 'activity',
+					},
+					{
+						name: 'Activity Type',
+						value: 'activityType',
+					},
+					{
+						name: 'Deal',
+						value: 'deal',
+					},
+					{
+						name: 'Note',
+						value: 'note',
+					},
+					{
+						name: 'Organization',
+						value: 'organization',
+					},
+					{
+						name: 'Person',
+						value: 'person',
+					},
+					{
+						name: 'Pipeline',
+						value: 'pipeline',
+					},
+					{
+						name: 'Product',
+						value: 'product',
+					},
+					{
+						name: 'Stage',
+						value: 'stage',
+					},
+					{
+						name: 'User',
+						value: 'user',
+					},
+				],
+				default: '*',
+				description: 'Type of object to receive notifications about.',
+			},
+		],
+
+	};
+
+	// @ts-ignore (because of request)
+	webhookMethods = {
+		default: {
+			async checkExists(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+
+				if (webhookData.webhookId === undefined) {
+					// No webhook id is set so no webhook can exist
+					return false;
+				}
+
+				// Webhook got created before so check if it still exists
+				const endpoint = `/webhooks`;
+
+				const responseData = await pipedriveApiRequest.call(this, 'GET', endpoint, {});
+
+				if (responseData.data === undefined) {
+					return false;
+				}
+
+				for (const existingData of responseData.data) {
+					if (existingData.id === webhookData.webhookId) {
+						// The webhook exists already
+						return true;
+					}
+				}
+
+				return false;
+			},
+			async create(this: IHookFunctions): Promise<boolean> {
+				const webhookUrl = this.getNodeWebhookUrl('default');
+				const authentication = this.getNodeParameter('authentication', 0) as string;
+
+				const eventAction = this.getNodeParameter('action') as string;
+				const eventObject = this.getNodeParameter('object') as string;
+
+				const endpoint = `/webhooks`;
+
+				const body = {
+					event_action: eventAction,
+					event_object: eventObject,
+					subscription_url: webhookUrl,
+					http_auth_user: undefined as string | undefined,
+					http_auth_password: undefined as string | undefined,
+				};
+
+				if (authentication === 'basicAuth') {
+					const httpBasicAuth = this.getCredentials('httpBasicAuth');
+
+					if (httpBasicAuth === undefined || !httpBasicAuth.user || !httpBasicAuth.password) {
+						// Data is not defined on node so can not authenticate
+						return false;
+					}
+
+					body.http_auth_user = httpBasicAuth.user as string;
+					body.http_auth_password = httpBasicAuth.password as string;
+				}
+
+				const responseData = await pipedriveApiRequest.call(this, 'POST', endpoint, body);
+
+				if (responseData.data === undefined || responseData.data.id === undefined) {
+					// Required data is missing so was not successful
+					return false;
+				}
+
+				const webhookData = this.getWorkflowStaticData('node');
+				webhookData.webhookId = responseData.data.id as string;
+
+				return true;
+			},
+			async delete(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+
+				if (webhookData.webhookId !== undefined) {
+					const endpoint = `/webhooks/${webhookData.webhookId}`;
+					const body = {};
+
+					try {
+						await pipedriveApiRequest.call(this, 'DELETE', endpoint, body);
+					} catch (e) {
+						return false;
+					}
+
+					// Remove from the static workflow data so that it is clear
+					// that no webhooks are registred anymore
+					delete webhookData.webhookId;
+					delete webhookData.webhookEvents;
+				}
+
+				return true;
+			},
+		},
+	};
+
+
+
+	async webhook(this: IWebhookFunctions): Promise<IWebhookResonseData> {
+		const req = this.getRequestObject();
+		const resp = this.getResponseObject();
+		const realm = 'Webhook';
+
+		const authentication = this.getNodeParameter('authentication', 0) as string;
+
+		if (authentication === 'basicAuth') {
+			// Basic authorization is needed to call webhook
+			const httpBasicAuth = this.getCredentials('httpBasicAuth');
+
+			if (httpBasicAuth === undefined || !httpBasicAuth.user || !httpBasicAuth.password) {
+				// Data is not defined on node so can not authenticate
+				return authorizationError(resp, realm, 500, 'No authentication data defined on node!');
+			}
+
+			const basicAuthData = basicAuth(req);
+
+			if (basicAuthData === undefined) {
+				// Authorization data is missing
+				return authorizationError(resp, realm, 401);
+			}
+
+			if (basicAuthData.name !== httpBasicAuth!.user || basicAuthData.pass !== httpBasicAuth!.password) {
+				// Provided authentication data is wrong
+				return authorizationError(resp, realm, 403);
+			}
+		}
+
+		return {
+			workflowData: [
+				this.helpers.returnJsonArray(req.body)
+			],
+		};
+	}
+}

packages/nodes-base/package.json

@@ -71,6 +71,7 @@
             "dist/nodes/NoOp.node.js",
             "dist/nodes/OpenWeatherMap.node.js",
             "dist/nodes/Pipedrive/Pipedrive.node.js",
+            "dist/nodes/Pipedrive/PipedriveTrigger.node.js",
             "dist/nodes/ReadBinaryFile.node.js",
             "dist/nodes/ReadBinaryFiles.node.js",
             "dist/nodes/Redis/Redis.node.js",