n8n/packages/nodes-base/nodes/CustomerIo/CustomerIoTrigger.node.ts

import {
	IHookFunctions,
	IWebhookFunctions,
} from 'n8n-core';

import {
	IDataObject,
	INodeType,
	INodeTypeDescription,
	IWebhookResponseData,
} from 'n8n-workflow';

import {
	customerIoApiRequest,
	eventExists,
} from './GenericFunctions';

interface IEvent {
	customer?: IDataObject;
	email?: IDataObject;
	push?: IDataObject;
	slack?: IDataObject;
	sms?: IDataObject;
	webhook?: IDataObject;
}

export class CustomerIoTrigger implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'Customer.io Trigger',
		name: 'customerIoTrigger',
		group: ['trigger'],
		icon: 'file:customerio.png',
		version: 1,
		description: 'Starts the workflow on a Customer.io update. (Beta)',
		defaults: {
			name: 'Customer.io Trigger',
			color: '#ffcd00',
		},
		inputs: [],
		outputs: ['main'],
		credentials: [
			{
				name: 'customerIoApi',
				required: true,
			},
		],
		webhooks: [
			{
				name: 'default',
				httpMethod: 'POST',
				responseMode: 'onReceived',
				path: 'webhook',
			},
		],
		properties: [
			{
				displayName: 'Events',
				name: 'events',
				type: 'multiOptions',
				required: true,
				default: [],
				description: 'The events that can trigger the webhook and whether they are enabled.',
				options: [
					{
						name: 'Customer Subscribed',
						value: 'customer.subscribed',
						description: 'Whether the webhook is triggered when a list subscriber is added.',
					},
					{
						name: 'Customer Unsubscribe',
						value: 'customer.unsubscribed',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email Attempted',
						value: 'email.attempted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email Bounced',
						value: 'email.bounced',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email clicked',
						value: 'email.clicked',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email converted',
						value: 'email.converted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email delivered',
						value: 'email.delivered',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email drafted',
						value: 'email.drafted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email failed',
						value: 'email.failed',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email opened',
						value: 'email.opened',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email sent',
						value: 'email.sent',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Email spammed',
						value: 'email.spammed',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push attempted',
						value: 'push.attempted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push bounced',
						value: 'push.bounced',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push clicked',
						value: 'push.clicked',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push delivered',
						value: 'push.delivered',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push drafted',
						value: 'push.drafted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push failed',
						value: 'push.failed',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push opened',
						value: 'push.opened',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Push sent',
						value: 'push.sent',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Slack attempted',
						value: 'slack.attempted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Slack clicked',
						value: 'slack.clicked',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Slack drafted',
						value: 'slack.drafted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Slack failed',
						value: 'slack.failed',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'Slack sent',
						value: 'slack.sent',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'SMS attempted',
						value: 'sms.attempted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'SMS bounced',
						value: 'sms.bounced',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'SMS clicked',
						value: 'sms.clicked',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'SMS delivered',
						value: 'sms.delivered',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'SMS drafted',
						value: 'sms.drafted',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'SMS failed',
						value: 'sms.failed',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
					{
						name: 'SMS sent',
						value: 'sms.sent',
						description: 'Whether the webhook is triggered when a list member unsubscribes.',
					},
				],
			},
		],
	};
	// @ts-ignore (because of request)
	webhookMethods = {
		default: {
			async checkExists(this: IHookFunctions): Promise<boolean> {
				const webhookUrl = this.getNodeWebhookUrl('default');

				const webhookData = this.getWorkflowStaticData('node');

				const currentEvents = this.getNodeParameter('events', []) as string[];

				const endpoint = '/reporting_webhooks';

				let { reporting_webhooks: webhooks } = await customerIoApiRequest.call(this, 'GET', endpoint, {}, 'beta');

				if (webhooks === null) {
					webhooks = [];
				}

				for (const webhook of webhooks) {
					if (webhook.endpoint === webhookUrl &&
						eventExists(currentEvents, webhook.events)) {
						webhookData.webhookId = webhook.id;
						return true;
					}
				}

				return false;
			},
			async create(this: IHookFunctions): Promise<boolean> {
				let webhook;
				const webhookUrl = this.getNodeWebhookUrl('default');
				const events = this.getNodeParameter('events', []) as string[];

				const endpoint = '/reporting_webhooks';

				const data: IEvent = {
					customer: {},
					email: {},
					push: {},
					slack: {},
					sms: {},
					webhook: {},
				};

				for (const event of events) {
					const option = event.split('.')[1];
					if (event.startsWith('customer')) {
						data.customer![option] = true;
					}
					if (event.startsWith('email')) {
						data.email![option] = true;
					}
					if (event.startsWith('push')) {
						data.push![option] = true;
					}
					if (event.startsWith('slack')) {
						data.slack![option] = true;
					}
					if (event.startsWith('sms')) {
						data.sms![option] = true;
					}
					if (event.startsWith('webhook')) {
						data.webhook![option] = true;
					}
				}
				const body = {
					endpoint: webhookUrl,
					events: data,
				};

				webhook = await customerIoApiRequest.call(this, 'POST', endpoint, body, 'beta');

				const webhookData = this.getWorkflowStaticData('node');
				webhookData.webhookId = webhook.id as string;
				return true;
			},
			async delete(this: IHookFunctions): Promise<boolean> {
				const webhookData = this.getWorkflowStaticData('node');

				if (webhookData.webhookId !== undefined) {
					const endpoint = `/reporting_webhooks/${webhookData.webhookId}`;
					try {
						await customerIoApiRequest.call(this, 'DELETE', endpoint, {}, 'beta');
					} catch (error) {
						return false;
					}
					delete webhookData.webhookId;
				}
				return true;
			},
		},
	};

	async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
		const bodyData = this.getBodyData();
		return {
			workflowData: [
				this.helpers.returnJsonArray(bodyData),
			],
		};
	}
}