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

434 lines
11 KiB
TypeScript
Raw Normal View History

import type { IHookFunctions, IWebhookFunctions } from 'n8n-core';
2020-01-05 10:34:09 -08:00
import type {
2020-01-05 18:32:22 -08:00
IDataObject,
2020-01-06 16:30:40 -08:00
ILoadOptionsFunctions,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
2020-01-05 10:34:09 -08:00
} from 'n8n-workflow';
import { NodeOperationError } from 'n8n-workflow';
2020-01-05 10:34:09 -08:00
import { zendeskApiRequest, zendeskApiRequestAllItems } from './GenericFunctions';
import { conditionFields } from './ConditionDescription';
2020-01-05 10:34:09 -08:00
import { triggerPlaceholders } from './TriggerPlaceholders';
2020-01-05 10:34:09 -08:00
export class ZendeskTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Zendesk Trigger',
name: 'zendeskTrigger',
icon: 'file:zendesk.svg',
2020-01-05 10:34:09 -08:00
group: ['trigger'],
version: 1,
description: 'Handle Zendesk events via webhooks',
defaults: {
name: 'Zendesk Trigger',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'zendeskApi',
required: true,
2020-06-09 06:53:17 -07:00
displayOptions: {
show: {
authentication: ['apiToken'],
2020-06-09 06:53:17 -07:00
},
},
},
{
name: 'zendeskOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: ['oAuth2'],
2020-06-09 06:53:17 -07:00
},
},
},
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
},
2020-01-05 10:34:09 -08:00
{
displayName: 'Service',
name: 'service',
type: 'options',
required: true,
options: [
{
name: 'Support',
value: 'support',
2020-10-22 06:46:03 -07:00
},
2020-01-05 10:34:09 -08:00
],
default: 'support',
},
2020-01-06 16:30:40 -08:00
{
displayName: 'Options',
name: 'options',
type: 'collection',
displayOptions: {
show: {
service: ['support'],
2020-01-06 16:30:40 -08:00
},
},
default: {},
2020-01-05 10:34:09 -08:00
options: [
{
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
displayName: 'Field Names or IDs',
2020-01-06 16:30:40 -08:00
name: 'fields',
description:
'The fields to return the values of. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
2020-01-06 16:30:40 -08:00
type: 'multiOptions',
default: [],
typeOptions: {
loadOptionsMethod: 'getFields',
},
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'],
2020-10-22 06:46:03 -07:00
},
2020-01-06 16:30:40 -08:00
},
description: 'The condition to set',
2020-01-06 16:30:40 -08:00
default: {},
options: [
{
name: 'all',
displayName: 'All',
values: [...conditionFields],
2020-01-06 16:52:37 -08:00
},
{
name: 'any',
displayName: 'Any',
values: [...conditionFields],
2020-01-06 16:52:37 -08:00
},
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 fields to display them to user so that he can
// select them easily
async getFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = triggerPlaceholders;
const customFields = [
'text',
'textarea',
'date',
'integer',
'decimal',
'regexp',
'multiselect',
'tagger',
];
const fields = await zendeskApiRequestAllItems.call(
this,
'ticket_fields',
'GET',
'/ticket_fields',
);
for (const field of fields) {
if (customFields.includes(field.type as string) && field.removable && field.active) {
const fieldName = field.title;
const fieldId = field.id;
returnData.push({
name: fieldName,
value: `ticket.ticket_field_${fieldId}`,
description: `Custom field ${fieldName}`,
});
}
}
return returnData;
},
2020-01-06 16:30:40 -08:00
// 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-10-22 06:46:03 -07:00
},
2020-01-06 16:30:40 -08:00
};
2020-01-05 10:34:09 -08:00
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default') as string;
2020-01-05 10:34:09 -08:00
const webhookData = this.getWorkflowStaticData('node');
const conditions = this.getNodeParameter('conditions') as IDataObject;
let endpoint = '';
const resultAll = [],
resultAny = [];
const conditionsAll = conditions.all as [IDataObject];
if (conditionsAll) {
for (const conditionAll of conditionsAll) {
const aux: IDataObject = {};
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-05 10:34:09 -08:00
}
const conditionsAny = conditions.any as [IDataObject];
if (conditionsAny) {
for (const conditionAny of conditionsAny) {
const aux: IDataObject = {};
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);
}
}
// get all webhooks
// https://developer.zendesk.com/api-reference/event-connectors/webhooks/webhooks/#list-webhooks
const { webhooks } = await zendeskApiRequest.call(this, 'GET', '/webhooks');
for (const webhook of webhooks) {
if (webhook.endpoint === webhookUrl) {
webhookData.targetId = webhook.id;
break;
}
}
// no target was found
if (webhookData.targetId === undefined) {
2020-01-05 10:34:09 -08:00
return false;
}
endpoint = '/triggers/active';
const triggers = await zendeskApiRequestAllItems.call(this, 'triggers', 'GET', endpoint);
for (const trigger of triggers) {
const toDeleteTriggers = [];
// this trigger belong to the current target
if (trigger.actions[0].value[0].toString() === webhookData.targetId?.toString()) {
toDeleteTriggers.push(trigger.id);
}
// delete all trigger attach to this target;
if (toDeleteTriggers.length !== 0) {
await zendeskApiRequest.call(
this,
'DELETE',
'/triggers/destroy_many',
{},
{ ids: toDeleteTriggers.join(',') },
);
}
}
return false;
2020-01-05 10:34:09 -08:00
},
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;
2020-01-06 16:30:40 -08:00
if (service === 'support') {
const message: IDataObject = {};
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;
2020-01-06 16:30:40 -08:00
if (Object.keys(conditions).length === 0) {
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
throw new NodeOperationError(this.getNode(), '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) {
for (const field of options.fields as string[]) {
2020-01-06 16:30:40 -08:00
message[field] = `{{${field}}}`;
}
} else {
message['ticket.id'] = '{{ticket.id}}';
2020-01-06 16:30:40 -08:00
}
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) {
const aux: IDataObject = {};
2020-01-06 16:52:37 -08:00
aux.field = conditionAll.field;
aux.operator = conditionAll.operation;
if (
conditionAll.operation !== 'changed' &&
conditionAll.operation !== 'not_changed'
) {
2020-01-06 16:52:37 -08:00
aux.value = conditionAll.value;
} else {
aux.value = null;
}
resultAll.push(aux);
2020-01-06 16:52:37 -08:00
}
}
2020-01-06 16:52:37 -08:00
const conditionsAny = conditions.any as [IDataObject];
if (conditionsAny) {
for (const conditionAny of conditionsAny) {
const aux: IDataObject = {};
2020-01-06 16:52:37 -08:00
aux.field = conditionAny.field;
aux.operator = conditionAny.operation;
if (
conditionAny.operation !== 'changed' &&
conditionAny.operation !== 'not_changed'
) {
2020-01-06 16:52:37 -08:00
aux.value = conditionAny.value;
} else {
aux.value = null;
}
resultAny.push(aux);
2020-01-06 16:30:40 -08:00
}
}
const urlParts = new URL(webhookUrl);
2020-01-06 16:30:40 -08:00
const bodyTrigger: IDataObject = {
trigger: {
title: `n8n-webhook:${urlParts.pathname}`,
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_webhook',
2020-01-06 16:30:40 -08:00
value: [],
},
],
2020-01-06 16:30:40 -08:00
},
};
2020-01-06 16:30:40 -08:00
const bodyTarget: IDataObject = {
webhook: {
name: 'n8n webhook',
endpoint: webhookUrl,
http_method: 'POST',
status: 'active',
request_format: 'json',
subscriptions: ['conditional_ticket_events'],
2020-01-06 16:30:40 -08:00
},
};
let target: IDataObject = {};
// if target id exists but trigger does not then reuse the target
// and create the trigger else create both
if (webhookData.targetId !== undefined) {
target.id = webhookData.targetId;
} else {
// create a webhook
// https://developer.zendesk.com/api-reference/event-connectors/webhooks/webhooks/#create-or-clone-webhook
target = (await zendeskApiRequest.call(this, 'POST', '/webhooks', bodyTarget))
.webhook as IDataObject;
}
((bodyTrigger.trigger as IDataObject).actions as IDataObject[])[0].value = [
target.id,
JSON.stringify(message),
];
2020-01-06 16:30:40 -08:00
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', `/webhooks/${webhookData.targetId}`);
} catch (error) {
2020-01-05 10:34:09 -08:00
return false;
}
delete webhookData.triggerId;
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 as IDataObject)],
2020-01-05 10:34:09 -08:00
};
}
}