import type {
IHookFunctions,
IWebhookFunctions,
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
} from 'n8n-workflow';
import { webflowApiRequest } from './GenericFunctions';
export class WebflowTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Webflow Trigger',
name: 'webflowTrigger',
icon: 'file:webflow.svg',
group: ['trigger'],
version: 1,
description: 'Handle Webflow events via webhooks',
defaults: {
name: 'Webflow Trigger',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'webflowApi',
required: true,
displayOptions: {
show: {
authentication: ['accessToken'],
},
},
},
{
name: 'webflowOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: ['oAuth2'],
},
},
},
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'Access Token',
value: 'accessToken',
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
default: 'accessToken',
},
{
displayName: 'Site Name or ID',
name: 'site',
type: 'options',
required: true,
default: '',
typeOptions: {
loadOptionsMethod: 'getSites',
},
description:
'Site that will trigger the events. Choose from the list, or specify an ID using an expression.',
},
{
displayName: 'Event',
name: 'event',
type: 'options',
required: true,
options: [
{
name: 'Collection Item Created',
value: 'collection_item_created',
},
{
name: 'Collection Item Deleted',
value: 'collection_item_deleted',
},
{
name: 'Collection Item Updated',
value: 'collection_item_changed',
},
{
name: 'Ecomm Inventory Changed',
value: 'ecomm_inventory_changed',
},
{
name: 'Ecomm New Order',
value: 'ecomm_new_order',
},
{
name: 'Ecomm Order Changed',
value: 'ecomm_order_changed',
},
{
name: 'Form Submission',
value: 'form_submission',
},
{
name: 'Site Publish',
value: 'site_publish',
},
],
default: 'form_submission',
},
// {
// displayName: 'All collections',
// name: 'allCollections',
// type: 'boolean',
// displayOptions: {
// show: {
// event: [
// 'collection_item_created',
// 'collection_item_changed',
// 'collection_item_deleted',
// ],
// },
// },
// required: false,
// default: true,
// description: 'Receive events from all collections',
// },
// {
// displayName: 'Collection',
// name: 'collection',
// type: 'options',
// required: false,
// default: '',
// typeOptions: {
// loadOptionsMethod: 'getCollections',
// loadOptionsDependsOn: [
// 'site',
// ],
// },
// description: 'Collection that will trigger the events',
// displayOptions: {
// show: {
// allCollections: [
// false,
// ],
// },
// },
// },
],
};
methods = {
loadOptions: {
// Get all the sites to display them to user so that he can
// select them easily
async getSites(this: ILoadOptionsFunctions): Promise {
const returnData: INodePropertyOptions[] = [];
const sites = await webflowApiRequest.call(this, 'GET', '/sites');
for (const site of sites) {
const siteName = site.name;
const siteId = site._id;
returnData.push({
name: siteName,
value: siteId,
});
}
return returnData;
},
// async getCollections(this: ILoadOptionsFunctions): Promise {
// const returnData: INodePropertyOptions[] = [];
// const siteId = this.getCurrentNodeParameter('site');
// const collections = await webflowApiRequest.call(this, 'GET', `/sites/${siteId}/collections`);
// for (const collection of collections) {
// returnData.push({
// name: collection.name,
// value: collection._id,
// });
// }
// return returnData;
// },
},
};
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise {
const webhookData = this.getWorkflowStaticData('node');
const webhookUrl = this.getNodeWebhookUrl('default');
const siteId = this.getNodeParameter('site') as string;
const event = this.getNodeParameter('event') as string;
const registeredWebhooks = (await webflowApiRequest.call(
this,
'GET',
`/sites/${siteId}/webhooks`,
)) as IDataObject[];
for (const webhook of registeredWebhooks) {
if (webhook.url === webhookUrl && webhook.triggerType === event) {
webhookData.webhookId = webhook._id;
return true;
}
}
return false;
},
async create(this: IHookFunctions): Promise {
const webhookUrl = this.getNodeWebhookUrl('default');
const webhookData = this.getWorkflowStaticData('node');
const siteId = this.getNodeParameter('site') as string;
const event = this.getNodeParameter('event') as string;
const endpoint = `/sites/${siteId}/webhooks`;
const body: IDataObject = {
site_id: siteId,
triggerType: event,
url: webhookUrl,
};
// if (event.startsWith('collection')) {
// const allCollections = this.getNodeParameter('allCollections') as boolean;
// if (allCollections === false) {
// body.filter = {
// 'cid': this.getNodeParameter('collection') as string,
// };
// }
// }
const { _id } = await webflowApiRequest.call(this, 'POST', endpoint, body);
webhookData.webhookId = _id;
return true;
},
async delete(this: IHookFunctions): Promise {
let responseData;
const webhookData = this.getWorkflowStaticData('node');
const siteId = this.getNodeParameter('site') as string;
const endpoint = `/sites/${siteId}/webhooks/${webhookData.webhookId}`;
try {
responseData = await webflowApiRequest.call(this, 'DELETE', endpoint);
} catch (error) {
return false;
}
if (!responseData.deleted) {
return false;
}
delete webhookData.webhookId;
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise {
const req = this.getRequestObject();
return {
workflowData: [this.helpers.returnJsonArray(req.body as IDataObject[])],
};
}
}