n8n/packages/nodes-base/nodes/TheHive/TheHiveTrigger.node.ts
Ricardo Espinoza aafbe5af40
Feature/thehive trigger improvements (#1259)
* Add support for TheHive3 webhook events

* Add Log Updated & Log Deleted events

* Remove configuration field

*  Small change (#1235)

* 👕 Fix lint issue

Co-authored-by: Mika Luhta <12100880+mluhta@users.noreply.github.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2020-12-19 18:19:12 +01:00

178 lines
4.3 KiB
TypeScript

import {
IWebhookFunctions,
} from 'n8n-core';
import {
IDataObject,
IHookFunctions,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
} from 'n8n-workflow';
export class TheHiveTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'TheHive Trigger',
name: 'theHiveTrigger',
icon: 'file:thehive.png',
group: ['trigger'],
version: 1,
description: 'Starts the workflow when a TheHive event occurs.',
defaults: {
name: 'TheHive Trigger',
color: '#f3d02f',
},
inputs: [],
outputs: ['main'],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
reponseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Events',
name: 'events',
type: 'multiOptions',
default: [],
required: true,
description: 'Events types',
options: [
{
name: '*',
value: '*',
description: 'Any time any event is triggered (Wildcard Event).',
},
{
name: 'Alert Created',
value: 'alert_create',
description: 'Triggered when an alert is created',
},
{
name: 'Alert Updated',
value: 'alert_update',
description: 'Triggered when an alert is updated',
},
{
name: 'Alert Deleted',
value: 'alert_delete',
description: 'Triggered when an alert is deleted',
},
{
name: 'Observable Created',
value: 'case_artifact_create',
description: 'Triggered when an observable is created',
},
{
name: 'Observable Updated',
value: 'case_artifact_update',
description: 'Triggered when an observable is updated',
},
{
name: 'Observable Deleted',
value: 'case_artifact_delete',
description: 'Triggered when an observable is deleted',
},
{
name: 'Case Created',
value: 'case_create',
description: 'Triggered when a case is created',
},
{
name: 'Case Updated',
value: 'case_update',
description: 'Triggered when a case is updated',
},
{
name: 'Case Deleted',
value: 'case_delete',
description: 'Triggered when a case is deleted',
},
{
name: 'Task Created',
value: 'case_task_create',
description: 'Triggered when a task is created',
},
{
name: 'Task Updated',
value: 'case_task_update',
description: 'Triggered when a task is updated',
},
{
name: 'Task Deleted',
value: 'case_task_delete',
description: 'Triggered when a task is deleted',
},
{
name: 'Log Created',
value: 'case_task_log_create',
description: 'Triggered when a task log is created',
},
{
name: 'Log Updated',
value: 'case_task_log_update',
description: 'Triggered when a task log is updated',
},
{
name: 'Log Deleted',
value: 'case_task_log_delete',
description: 'Triggered when a task log is deleted',
},
],
},
],
};
// @ts-ignore (because of request)
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
return true;
},
async create(this: IHookFunctions): Promise<boolean> {
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
// Get the request body
const bodyData = this.getBodyData();
const events = this.getNodeParameter('events', []) as string[];
if (!bodyData.operation || !bodyData.objectType) {
// Don't start the workflow if mandatory fields are not specified
return {};
}
// Don't start the workflow if the event is not fired
// Replace Creation with Create for TheHive 3 support
const operation = (bodyData.operation as string).replace('Creation', 'Create');
const event = `${(bodyData.objectType as string).toLowerCase()}_${operation.toLowerCase()}`;
if (events.indexOf('*') === -1 && events.indexOf(event) === -1) {
return {};
}
// The data to return and so start the workflow with
const returnData: IDataObject[] = [];
returnData.push(
{
event,
body: this.getBodyData(),
headers: this.getHeaderData(),
query: this.getQueryData(),
},
);
return {
workflowData: [
this.helpers.returnJsonArray(returnData),
],
};
}
}