n8n-nodes-base
Version:
Base nodes of n8n
408 lines • 17.3 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ZendeskTrigger = void 0;
const n8n_workflow_1 = require("n8n-workflow");
const ConditionDescription_1 = require("./ConditionDescription");
const GenericFunctions_1 = require("./GenericFunctions");
const TriggerPlaceholders_1 = require("./TriggerPlaceholders");
const ZendeskTriggerHelpers_1 = require("./ZendeskTriggerHelpers");
class ZendeskTrigger {
description = {
displayName: 'Zendesk Trigger',
name: 'zendeskTrigger',
icon: 'file:zendesk.svg',
group: ['trigger'],
version: 1,
description: 'Handle Zendesk events via webhooks',
defaults: {
name: 'Zendesk Trigger',
},
inputs: [],
outputs: [n8n_workflow_1.NodeConnectionTypes.Main],
credentials: [
{
name: 'zendeskApi',
required: true,
displayOptions: {
show: {
authentication: ['apiToken'],
},
},
},
{
name: 'zendeskOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: ['oAuth2'],
},
},
},
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'API Token',
value: 'apiToken',
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
default: 'apiToken',
},
{
displayName: 'Service',
name: 'service',
type: 'options',
required: true,
options: [
{
name: 'Support',
value: 'support',
},
],
default: 'support',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
displayOptions: {
show: {
service: ['support'],
},
},
default: {},
options: [
{
displayName: 'Field Names or IDs',
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/expressions/">expression</a>.',
type: 'multiOptions',
default: [],
typeOptions: {
loadOptionsMethod: 'getFields',
},
},
],
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: [...ConditionDescription_1.conditionFields],
},
{
name: 'any',
displayName: 'Any',
values: [...ConditionDescription_1.conditionFields],
},
],
},
],
};
methods = {
loadOptions: {
// Get all the fields to display them to user so that they can
// select them easily
async getFields() {
const returnData = TriggerPlaceholders_1.triggerPlaceholders;
const customFields = [
'text',
'textarea',
'date',
'integer',
'decimal',
'regexp',
'multiselect',
'tagger',
];
const fields = await GenericFunctions_1.zendeskApiRequestAllItems.call(this, 'ticket_fields', 'GET', '/ticket_fields');
for (const field of fields) {
if (customFields.includes(field.type) && 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;
},
// Get all the groups to display them to user so that they can
// select them easily
async getGroups() {
const returnData = [];
const groups = await GenericFunctions_1.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 they can
// select them easily
async getUsers() {
const returnData = [];
const users = await GenericFunctions_1.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',
});
returnData.push({
name: 'Requester',
value: 'requester_id',
});
return returnData;
},
},
};
webhookMethods = {
default: {
async checkExists() {
const webhookUrl = this.getNodeWebhookUrl('default');
const webhookData = this.getWorkflowStaticData('node');
const conditions = this.getNodeParameter('conditions');
let endpoint = '';
const resultAll = [], resultAny = [];
const conditionsAll = conditions.all;
if (conditionsAll) {
for (const conditionAll of conditionsAll) {
const aux = {};
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);
}
}
const conditionsAny = conditions.any;
if (conditionsAny) {
for (const conditionAny of conditionsAny) {
const aux = {};
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 GenericFunctions_1.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) {
return false;
}
endpoint = '/triggers/active';
const triggers = await GenericFunctions_1.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 GenericFunctions_1.zendeskApiRequest.call(this, 'DELETE', '/triggers/destroy_many', {}, { ids: toDeleteTriggers.join(',') });
}
}
return false;
},
async create() {
const webhookUrl = this.getNodeWebhookUrl('default');
const webhookData = this.getWorkflowStaticData('node');
const service = this.getNodeParameter('service');
if (service === 'support') {
const message = {};
const resultAll = [], resultAny = [];
const conditions = this.getNodeParameter('conditions');
const options = this.getNodeParameter('options');
if (Object.keys(conditions).length === 0) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'You must have at least one condition');
}
if (options.fields) {
for (const field of options.fields) {
message[field] = `{{${field}}}`;
}
}
else {
message['ticket.id'] = '{{ticket.id}}';
}
const conditionsAll = conditions.all;
if (conditionsAll) {
for (const conditionAll of conditionsAll) {
const aux = {};
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);
}
}
const conditionsAny = conditions.any;
if (conditionsAny) {
for (const conditionAny of conditionsAny) {
const aux = {};
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);
}
}
const urlParts = new URL(webhookUrl);
const bodyTrigger = {
trigger: {
title: `n8n-webhook:${urlParts.pathname}`,
conditions: {
all: resultAll,
any: resultAny,
},
actions: [
{
field: 'notification_webhook',
value: [],
},
],
},
};
const bodyTarget = {
webhook: {
name: 'n8n webhook',
endpoint: webhookUrl,
http_method: 'POST',
status: 'active',
request_format: 'json',
subscriptions: ['conditional_ticket_events'],
},
};
let target = {};
// 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 GenericFunctions_1.zendeskApiRequest.call(this, 'POST', '/webhooks', bodyTarget))
.webhook;
}
// Fetch the signing secret for webhook signature verification
// https://developer.zendesk.com/api-reference/event-connectors/webhooks/webhooks/#show-webhook-signing-secret
const signingSecretResponse = (await GenericFunctions_1.zendeskApiRequest.call(this, 'GET', `/webhooks/${target.id}/signing_secret`));
if (signingSecretResponse.signing_secret?.secret) {
webhookData.webhookSecret = signingSecretResponse.signing_secret.secret;
}
bodyTrigger.trigger.actions[0].value = [
target.id,
JSON.stringify(message),
];
const { trigger } = await GenericFunctions_1.zendeskApiRequest.call(this, 'POST', '/triggers', bodyTrigger);
webhookData.webhookId = trigger.id;
webhookData.targetId = target.id;
}
return true;
},
async delete() {
const webhookData = this.getWorkflowStaticData('node');
try {
await GenericFunctions_1.zendeskApiRequest.call(this, 'DELETE', `/triggers/${webhookData.webhookId}`);
await GenericFunctions_1.zendeskApiRequest.call(this, 'DELETE', `/webhooks/${webhookData.targetId}`);
}
catch (error) {
return false;
}
delete webhookData.webhookId;
delete webhookData.targetId;
delete webhookData.webhookSecret;
return true;
},
},
};
async webhook() {
// Verify the webhook signature before processing
if (!ZendeskTriggerHelpers_1.verifySignature.call(this)) {
const res = this.getResponseObject();
res.status(401).send('Unauthorized').end();
return {
noWebhookResponse: true,
};
}
const req = this.getRequestObject();
return {
workflowData: [this.helpers.returnJsonArray(req.body)],
};
}
}
exports.ZendeskTrigger = ZendeskTrigger;
//# sourceMappingURL=ZendeskTrigger.node.js.map