n8n/packages/nodes-base/nodes/Iterable/EventDescription.ts

146 lines
3 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const eventOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'event',
],
},
},
options: [
{
name: 'Track',
value: 'track',
description: 'Record the actions a user perform',
},
],
default: 'track',
description: 'The operation to perform.',
},
];
export const eventFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* event:track */
/* -------------------------------------------------------------------------- */
{
displayName: 'Name',
name: 'name',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'event',
],
operation: [
'track',
],
},
},
description: 'The name of the event to track.',
default: '',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'event',
],
operation: [
'track',
],
},
},
options: [
{
displayName: 'Campaign ID',
name: 'campaignId',
type: 'string',
default: '',
description: `Campaign tied to conversion`,
},
{
displayName: 'Created At',
name: 'createdAt',
type: 'dateTime',
default: '',
description: `Time event happened.`,
},
{
displayName: 'Data Fields',
name: 'dataFieldsUi',
type: 'fixedCollection',
default: '',
placeholder: 'Add Data Field',
typeOptions: {
multipleValues: true,
},
options: [
{
name: 'dataFieldValues',
displayName: 'Data Field',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
description: 'The end event specified key of the event defined data.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'The end event specified value of the event defined data.',
},
],
},
],
},
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: `Either email or userId must be passed in to identify the user. If both are passed in, email takes precedence.`,
},
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
description: `Optional event id. If an event exists with that id, the event will be updated. If none is specified, a new id will automatically be generated and returned.`,
},
{
displayName: 'Template ID',
name: 'templateId',
type: 'string',
default: '',
description: `Template id`,
},
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
description: `userId that was passed into the updateUser call`,
},
],
},
];