feat: add webhook CRUD

nodes/Vikunja/Vikunja.node.ts

@@ -9,6 +9,7 @@ import {taskProperties} from './properties/Task'
 import {projectProperties} from './properties/Project'
 import {labelProperties} from './properties/Label'
 import {searchAndMap} from './helper'
+import {webhookProperties} from './properties/Webhook'
 
 export class Vikunja implements INodeType {
 	description: INodeTypeDescription = {
@@ -56,6 +57,10 @@ export class Vikunja implements INodeType {
 						name: 'Label',
 						value: 'label',
 					},
+					{
+						name: 'Webhook',
+						value: 'webhook',
+					},
 				],
 				default: 'task',
 			},
@@ -63,6 +68,7 @@ export class Vikunja implements INodeType {
 			...taskProperties,
 			...projectProperties,
 			...labelProperties,
+			...webhookProperties,
 		],
 	}
 

nodes/Vikunja/properties/Webhook.ts

@@ -0,0 +1,205 @@
+import {INodeProperties} from 'n8n-workflow'
+
+const availableWebhookEvents = [
+	// Copied from /api/v1/webhooks/events
+	'project.deleted',
+	'project.shared.team',
+	'project.shared.user',
+	'project.updated',
+	'task.assignee.created',
+	'task.assignee.deleted',
+	'task.attachment.created',
+	'task.attachment.deleted',
+	'task.comment.created',
+	'task.comment.deleted',
+	'task.comment.edited',
+	'task.created',
+	'task.deleted',
+	'task.relation.created',
+	'task.relation.deleted',
+	'task.updated'
+].map(e => ({
+	name: e,
+	value: e,
+}))
+
+export const webhookProperties: INodeProperties[] = [
+	{
+		displayName: 'Operation',
+		name: 'operation',
+		type: 'options',
+		noDataExpression: true,
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['webhook'],
+			},
+		},
+		options: [
+			{
+				name: 'Create',
+				value: 'create',
+				description: 'Create a webhook',
+				action: 'Create a webhook',
+				routing: {
+					request: {
+						method: 'PUT',
+						url: '=/projects/{{$parameter.webhookProject}}/webhooks',
+					},
+				},
+			},
+			{
+				name: 'Delete',
+				value: 'delete',
+				description: 'Delete a webhook',
+				action: 'Delete a webhook',
+				routing: {
+					request: {
+						method: 'DELETE',
+						url: '=/projects/{{$parameter.webhookProject}}/webhooks/{{$parameter.webhook}}',
+					},
+				},
+			},
+			{
+				name: 'Get Many',
+				value: 'getAll',
+				description: 'Get many webhooks',
+				action: 'Get many webhooks',
+				routing: {
+					request: {
+						method: 'GET',
+						url: '=/projects/{{$parameter.webhookProject}}/webhooks',
+					},
+				},
+			},
+			{
+				name: 'Update',
+				value: 'update',
+				description: 'Update a webhook',
+				action: 'Update a webhook',
+				routing: {
+					request: {
+						method: 'POST',
+						url: '=/projects/{{$parameter.webhookProject}}/webhooks/{{$parameter.webhook}}',
+					},
+				},
+			},
+		],
+		default: 'create',
+	},
+	{
+		displayName: 'Project Title or ID',
+		name: 'webhookProject',
+		type: 'resourceLocator',
+		default: {mode: 'id', value: ''},
+		required: true,
+		modes: [
+			{
+				displayName: 'From List',
+				name: 'list',
+				type: 'list',
+				placeholder: 'Select a project…',
+				typeOptions: {
+					searchListMethod: 'searchProjects',
+					searchable: true,
+				},
+			},
+			{
+				displayName: 'ID',
+				name: 'id',
+				type: 'string',
+				placeholder: '1567890',
+			},
+		],
+		displayOptions: {
+			show: {
+				resource: ['webhook'],
+				operation: [
+					'getAll',
+					'create',
+					'delete',
+					'update',
+				],
+			},
+		},
+		description: 'The project you want to operate on. Choose from the list, or specify an ID.',
+	},
+	{
+		displayName: 'Webhook ID',
+		name: 'webhook',
+		type: 'number',
+		required: true,
+		default: 0,
+		displayOptions: {
+			show: {
+				resource: ['webhook'],
+				operation: ['update', 'delete'],
+			},
+		},
+		routing: {
+			send: {
+				type: 'body',
+				property: 'webhook_id',
+			},
+		},
+		description: 'The webhook you want to operate on. Choose from the list, or specify an ID.',
+	},
+	{
+		displayName: 'Webhook Target URL',
+		name: 'webhookTarget',
+		type: 'string',
+		displayOptions: {
+			show: {
+				resource: ['webhook'],
+				operation: ['create', 'update'],
+			},
+		},
+		routing: {
+			send: {
+				type: 'body',
+				property: 'target_url',
+			},
+		},
+		default: '',
+		required: true,
+	},
+	{
+		displayName: 'Secret',
+		name: 'secret',
+		type: 'string',
+		default: '',
+		description: 'If provided, webhook requests will be signed using HMAC. Check out the docs about how to use this: https://vikunja.io/docs/webhooks/#signing.',
+		displayOptions: {
+			show: {
+				resource: ['webhook'],
+				operation: ['create', 'update'],
+			},
+		},
+		routing: {
+			send: {
+				type: 'body',
+				property: 'secret',
+			},
+		},
+	},
+	{
+		displayName: 'Events',
+		name: 'events',
+		type: 'multiOptions',
+		default: [],
+		description: 'The webhook events which should fire this webhook target',
+		options: availableWebhookEvents,
+		displayOptions: {
+			show: {
+				resource: ['webhook'],
+				operation: ['create', 'update'],
+			},
+		},
+		routing: {
+			send: {
+				type: 'body',
+				property: 'events',
+			},
+		},
+	},
+]