n8n/packages/nodes-base/nodes/Zendesk/ZendeskTrigger.node.ts

559 lines
14 KiB
TypeScript
Raw Normal View History

import {
parse as urlParse,
} from 'url';
2020-01-05 10:34:09 -08:00
import {
IHookFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
INodeTypeDescription,
INodeType,
IWebhookResponseData,
2020-01-05 18:32:22 -08:00
IDataObject,
2020-01-06 16:30:40 -08:00
INodePropertyOptions,
ILoadOptionsFunctions,
2020-01-05 10:34:09 -08:00
} from 'n8n-workflow';
import {
zendeskApiRequest,
2020-01-06 16:30:40 -08:00
zendeskApiRequestAllItems,
2020-01-05 10:34:09 -08:00
} from './GenericFunctions';
2020-01-06 16:52:37 -08:00
import {
2020-04-06 16:11:50 -07:00
conditionFields,
2020-01-06 16:52:37 -08:00
} from './ConditionDescription';
2020-01-05 10:34:09 -08:00
export class ZendeskTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Zendesk Trigger',
name: 'zendeskTrigger',
2020-01-05 10:34:09 -08:00
icon: 'file:zendesk.png',
group: ['trigger'],
version: 1,
description: 'Handle Zendesk events via webhooks',
defaults: {
name: 'Zendesk Trigger',
2020-01-06 16:30:40 -08:00
color: '#13353c',
2020-01-05 10:34:09 -08:00
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'zendeskApi',
required: true,
2020-06-09 06:53:17 -07:00
displayOptions: {
show: {
authentication: [
2020-06-14 15:19:35 -07:00
'apiToken',
2020-06-09 06:53:17 -07:00
],
},
},
},
{
name: 'zendeskOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: [
'oAuth2',
],
},
},
},
2020-01-05 10:34:09 -08:00
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
2020-06-09 06:53:17 -07:00
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
2020-06-14 15:19:35 -07:00
name: 'API Token',
value: 'apiToken',
2020-06-09 06:53:17 -07:00
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
2020-06-14 15:19:35 -07:00
default: 'apiToken',
2020-06-09 06:53:17 -07:00
description: 'The resource to operate on.',
},
2020-01-05 10:34:09 -08:00
{
displayName: 'Service',
name: 'service',
type: 'options',
required: true,
options: [
{
name: 'Support',
value: 'support',
}
],
default: 'support',
description: '',
},
2020-01-06 16:30:40 -08:00
{
displayName: 'Options',
name: 'options',
type: 'collection',
displayOptions: {
show: {
service: [
'support'
],
},
},
default: {},
2020-01-05 10:34:09 -08:00
options: [
{
2020-01-06 16:30:40 -08:00
displayName: 'Fields',
name: 'fields',
description: 'The fields to return the values of.',
2020-01-06 16:30:40 -08:00
type: 'multiOptions',
default: [],
options: [
{
name: 'Title',
value: 'ticket.title',
description: `Ticket's subject`,
},
{
name: 'Description',
value: 'ticket.description',
description: `Ticket's description`,
},
{
name: 'URL',
value: 'ticket.url',
description: `Ticket's URL`,
},
{
name: 'ID',
value: 'ticket.id',
description: `Ticket's ID`,
},
{
name: 'External ID',
value: 'ticket.external_id',
description: `Ticket's external ID`,
},
{
name: 'Via',
value: 'ticket.via',
description: `Ticket's source`
},
{
name: 'Status',
value: 'ticket.status',
description: `Ticket's status`,
},
{
name: 'Priority',
value: 'ticket.priority',
description: `Ticket's priority`,
},
{
name: 'Type',
value: 'ticket.ticket_type',
description: `Ticket's type`,
},
{
name: 'Group Name',
value: 'ticket.group.name',
description: `Ticket's assigned group`,
},
{
name: 'Brand Name',
value: 'ticket.brand.name',
description: `Ticket's brand`,
},
{
name: 'Due Date',
value: 'ticket.due_date',
description: `Ticket's due date (relevant for tickets of type Task)`,
},
{
name: 'Account',
value: 'ticket.account',
description: `This Zendesk Support's account name`,
},
{
name: 'Assignee Email',
value: 'ticket.assignee.email',
description: `Ticket assignee email (if any)`,
},
{
name: 'Assignee Name',
value: 'ticket.assignee.name',
description: `Assignee's full name`,
},
{
name: 'Assignee First Name',
value: 'ticket.assignee.first_name',
description: `Assignee's first name`,
},
{
name: 'Assignee Last Name',
value: 'ticket.assignee.last_name',
description: `Assignee's last name`,
},
{
name: 'Requester Full Name',
value: 'ticket.requester.name',
description: `Requester's full name`,
},
{
name: 'Requester First Name',
value: 'ticket.requester.first_name',
description: `Requester's first name`,
},
{
name: 'Requester Last Name',
value: 'ticket.requester.last_name',
description: `Requester's last name`,
},
{
name: 'Requester Email',
value: 'ticket.requester.email',
description: `Requester's email`,
},
{
name: 'Requester Language',
value: 'ticket.requester.language',
description: `Requester's language`,
},
{
name: 'Requester Phone',
value: 'ticket.requester.phone',
description: `Requester's phone number`,
},
{
name: 'Requester External ID',
value: 'ticket.requester.external_id',
description: `Requester's external ID`,
},
{
name: 'Requester Field',
value: 'ticket.requester.requester_field',
description: `Name or email`,
},
{
name: 'Requester Details',
value: 'ticket.requester.details',
description: `Detailed information about the ticket's requester`,
},
{
name: 'Requester Organization',
value: 'ticket.organization.name',
description: `Requester's organization`,
},
{
name: `Ticket's Organization External ID`,
value: 'ticket.organization.external_id',
description: `Ticket's organization external ID`,
},
{
name: `Organization details`,
value: 'ticket.organization.details',
description: `The details about the organization of the ticket's requester`,
},
{
name: `Organization Note`,
value: 'ticket.organization.notes',
description: `The notes about the organization of the ticket's requester`,
},
{
name: `Ticket's CCs`,
value: 'ticket.ccs',
description: `Ticket's CCs`,
},
{
name: `Ticket's CCs names`,
value: 'ticket.cc_names',
description: `Ticket's CCs names`,
},
{
name: `Ticket's tags`,
value: 'ticket.tags',
description: `Ticket's tags`,
},
{
name: `Current Holiday Name`,
value: 'ticket.current_holiday_name',
description: `Displays the name of the current holiday on the ticket's schedule`,
},
{
name: `Current User Name `,
value: 'current_user.name',
description: `Your full name`,
},
{
name: `Current User First Name `,
value: 'current_user.first_name',
description: 'Your first name',
},
{
name: `Current User Email `,
value: 'current_user.email',
description: 'Your primary email',
},
{
name: `Current User Organization Name `,
value: 'current_user.organization.name',
description: 'Your default organization',
},
{
name: `Current User Organization Details `,
value: 'current_user.organization.details',
description: `Your default organization's details`,
},
{
name: `Current User Organization Notes `,
value: 'current_user.organization.notes',
description: `Your default organization's note`,
},
{
name: `Current User Language `,
value: 'current_user.language',
description: `Your chosen language`,
},
{
name: `Current User External ID `,
value: 'current_user.external_id',
description: 'Your external ID',
},
{
name: `Current User Notes `,
value: 'current_user.notes',
description: 'Your notes, stored in your profile',
},
{
name: `Satisfation Current Rating `,
value: 'satisfaction.current_rating',
description: 'The text of the current satisfaction rating',
},
{
name: `Satisfation Current Comment `,
value: 'satisfaction.current_comment',
description: 'The text of the current satisfaction rating comment``',
},
],
2020-01-05 10:34:09 -08:00
},
],
2020-01-06 16:30:40 -08:00
placeholder: 'Add Option',
},
{
displayName: 'Conditions',
name: 'conditions',
placeholder: 'Add Condition',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
service: [
'support'
],
}
},
description: 'The condition to set.',
default: {},
options: [
{
name: 'all',
displayName: 'All',
values: [
2020-01-06 16:52:37 -08:00
...conditionFields,
2020-01-06 16:30:40 -08:00
]
2020-01-06 16:52:37 -08:00
},
{
name: 'any',
displayName: 'Any',
values: [
...conditionFields,
]
},
2020-01-06 16:30:40 -08:00
],
2020-01-05 10:34:09 -08:00
},
],
};
2020-01-06 16:30:40 -08:00
methods = {
loadOptions: {
// Get all the groups to display them to user so that he can
// select them easily
async getGroups(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const groups = await zendeskApiRequestAllItems.call(this, 'groups', 'GET', '/groups');
for (const group of groups) {
const groupName = group.name;
const groupId = group.id;
returnData.push({
name: groupName,
value: groupId,
});
}
return returnData;
},
// Get all the users to display them to user so that he can
// select them easily
async getUsers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const users = await zendeskApiRequestAllItems.call(this, 'users', 'GET', '/users');
for (const user of users) {
const userName = user.name;
const userId = user.id;
returnData.push({
name: userName,
value: userId,
});
}
returnData.push({
name: 'Current User',
value: 'current_user',
});
2020-01-06 16:30:40 -08:00
returnData.push({
name: 'Requester',
value: 'requester_id',
});
2020-01-06 16:30:40 -08:00
return returnData;
},
}
};
2020-01-05 10:34:09 -08:00
// @ts-ignore
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
if (webhookData.webhookId === undefined) {
return false;
}
2020-01-05 18:32:22 -08:00
const endpoint = `/triggers/${webhookData.webhookId}`;
2020-01-05 10:34:09 -08:00
try {
2020-01-05 18:32:22 -08:00
await zendeskApiRequest.call(this, 'GET', endpoint);
2020-01-05 10:34:09 -08:00
} catch (e) {
return false;
}
return true;
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default') as string;
2020-01-05 10:34:09 -08:00
const webhookData = this.getWorkflowStaticData('node');
2020-01-06 16:30:40 -08:00
const service = this.getNodeParameter('service') as string;
if (service === 'support') {
const aux: IDataObject = {};
const message: IDataObject = {};
2020-01-06 16:52:37 -08:00
const resultAll = [], resultAny = [];
2020-01-06 16:30:40 -08:00
const conditions = this.getNodeParameter('conditions') as IDataObject;
const options = this.getNodeParameter('options') as IDataObject;
if (Object.keys(conditions).length === 0) {
throw new Error('You must have at least one condition');
2020-01-05 18:32:22 -08:00
}
2020-01-06 16:30:40 -08:00
if (options.fields) {
// @ts-ignore
for (const field of options.fields) {
2020-01-06 16:30:40 -08:00
// @ts-ignore
message[field] = `{{${field}}}`;
}
} else {
message['ticket.id'] = '{{ticket.id}}';
2020-01-06 16:30:40 -08:00
}
const conditionsAll = conditions.all as [IDataObject];
2020-01-06 16:52:37 -08:00
if (conditionsAll) {
for (const conditionAll of conditionsAll) {
2020-01-06 16:52:37 -08:00
aux.field = conditionAll.field;
aux.operator = conditionAll.operation;
if (conditionAll.operation !== 'changed'
&& conditionAll.operation !== 'not_changed') {
aux.value = conditionAll.value;
} else {
aux.value = null;
}
resultAll.push(aux);
2020-01-06 16:52:37 -08:00
}
}
const conditionsAny = conditions.any as [IDataObject];
if (conditionsAny) {
for (const conditionAny of conditionsAny) {
2020-01-06 16:52:37 -08:00
aux.field = conditionAny.field;
aux.operator = conditionAny.operation;
if (conditionAny.operation !== 'changed'
&& conditionAny.operation !== 'not_changed') {
aux.value = conditionAny.value;
} else {
aux.value = null;
}
resultAny.push(aux);
2020-01-06 16:30:40 -08:00
}
}
const urlParts = urlParse(webhookUrl);
2020-01-06 16:30:40 -08:00
const bodyTrigger: IDataObject = {
trigger: {
title: `n8n-webhook:${urlParts.path}`,
2020-01-06 16:30:40 -08:00
conditions: {
all: resultAll,
2020-01-06 16:52:37 -08:00
any: resultAny,
2020-01-06 16:30:40 -08:00
},
actions: [
{
field: 'notification_target',
value: [],
}
]
},
};
2020-01-06 16:30:40 -08:00
const bodyTarget: IDataObject = {
target: {
title: 'n8n webhook',
2020-01-06 16:30:40 -08:00
type: 'http_target',
target_url: webhookUrl,
method: 'POST',
active: true,
content_type: 'application/json',
},
};
const { target } = await zendeskApiRequest.call(this, 'POST', '/targets', bodyTarget);
// @ts-ignore
bodyTrigger.trigger.actions[0].value = [target.id, JSON.stringify(message)];
const { trigger } = await zendeskApiRequest.call(this, 'POST', '/triggers', bodyTrigger);
webhookData.webhookId = trigger.id;
webhookData.targetId = target.id;
2020-01-05 10:34:09 -08:00
}
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
try {
2020-01-05 18:32:22 -08:00
await zendeskApiRequest.call(this, 'DELETE', `/triggers/${webhookData.webhookId}`);
await zendeskApiRequest.call(this, 'DELETE', `/targets/${webhookData.targetId}`);
2020-01-05 10:34:09 -08:00
} catch(error) {
return false;
}
delete webhookData.webhookId;
delete webhookData.targetId;
2020-01-05 10:34:09 -08:00
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const req = this.getRequestObject();
return {
workflowData: [
this.helpers.returnJsonArray(req.body)
],
};
}
}