first commit
Security: Sync from Public / sync-from-public (push) Has been cancelled
Test: Benchmark Nightly / build (push) Has been cancelled
Test: Benchmark Nightly / Notify Cats on failure (push) Has been cancelled
CI: Python / Checks (push) Has been cancelled
Test: Evals Python / Workflow Comparison Python (push) Has been cancelled
Util: Check Docs URLs / check-docs-urls (push) Has been cancelled
Test: Visual Storybook / Cloudflare Pages (push) Has been cancelled
Test: E2E Performance / build-and-test-performance (push) Has been cancelled
Test: Workflows Nightly / Run Workflow Tests (push) Has been cancelled
Util: Cleanup CI Docker Images / Delete stale CI images (push) Has been cancelled
Test: Benchmark Destroy Env / build (push) Has been cancelled
Util: Update Node Popularity / update-popularity (push) Has been cancelled
Test: E2E Coverage Weekly / Coverage Tests (push) Has been cancelled

This commit is contained in:
2026-03-17 16:22:57 +03:30
commit 3d5eaf9445
15349 changed files with 2847338 additions and 0 deletions
@@ -0,0 +1,34 @@
import type {
IDataObject,
IExecuteFunctions,
IHookFunctions,
IHttpRequestMethods,
ILoadOptionsFunctions,
IRequestOptions,
IWebhookFunctions,
} from 'n8n-workflow';
export async function segmentApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions | IWebhookFunctions,
method: IHttpRequestMethods,
resource: string,
body: any = {},
qs: IDataObject = {},
uri?: string,
_option: IDataObject = {},
): Promise<any> {
const options: IRequestOptions = {
headers: {
'Content-Type': 'application/json',
},
method,
qs,
body,
uri: uri || `https://api.segment.io/v1${resource}`,
json: true,
};
if (!Object.keys(body as IDataObject).length) {
delete options.body;
}
return await this.helpers.requestWithAuthentication.call(this, 'segmentApi', options);
}
@@ -0,0 +1,328 @@
import type { INodeProperties } from 'n8n-workflow';
export const groupOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['group'],
},
},
options: [
{
name: 'Add',
value: 'add',
description: 'Add a user to a group',
action: 'Add a user to a group',
},
],
default: 'add',
},
];
export const groupFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* group:add */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['group'],
operation: ['add'],
},
},
},
{
displayName: 'Group ID',
name: 'groupId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['group'],
operation: ['add'],
},
},
description:
'A Group ID is the unique identifier which you recognize a group by in your own database',
required: true,
},
{
displayName: 'Traits',
name: 'traits',
placeholder: 'Add Trait',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
resource: ['group'],
operation: ['add'],
},
},
default: {},
options: [
{
name: 'traitsUi',
displayName: 'Trait',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Context',
name: 'context',
placeholder: 'Add Context',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['group'],
operation: ['add'],
},
},
default: {},
options: [
{
name: 'contextUi',
displayName: 'Context',
values: [
{
displayName: 'Active',
name: 'active',
type: 'boolean',
default: false,
description: 'Whether a user is active',
},
{
displayName: 'IP',
name: 'ip',
type: 'string',
default: '',
description: 'Current users IP address',
},
{
displayName: 'Locale',
name: 'locate',
type: 'string',
default: '',
description: 'Locale string for the current user, for example en-US',
},
{
displayName: 'Page',
name: 'page',
type: 'string',
default: '',
description:
'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
},
{
displayName: 'Timezone',
name: 'timezone',
type: 'string',
default: '',
description:
'Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York',
},
{
displayName: 'App',
name: 'app',
placeholder: 'Add App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'appUi',
displayName: 'App',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
{
displayName: 'Build',
name: 'build',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Campaign',
name: 'campaign',
placeholder: 'Campaign App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'campaignUi',
displayName: 'Campaign',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Source',
name: 'source',
type: 'string',
default: '',
},
{
displayName: 'Medium',
name: 'medium',
type: 'string',
default: '',
},
{
displayName: 'Term',
name: 'term',
type: 'string',
default: '',
},
{
displayName: 'Content',
name: 'content',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Device',
name: 'device',
placeholder: 'Add Device',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'deviceUi',
displayName: 'Device',
values: [
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
},
{
displayName: 'Manufacturer',
name: 'manufacturer',
type: 'string',
default: '',
},
{
displayName: 'Model',
name: 'model',
type: 'string',
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
],
},
],
},
],
},
],
},
{
displayName: 'Integration',
name: 'integrations',
placeholder: 'Add Integration',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['group'],
operation: ['add'],
},
},
default: {},
options: [
{
name: 'integrationsUi',
displayName: 'Integration',
values: [
{
displayName: 'All',
name: 'all',
type: 'boolean',
default: true,
},
{
displayName: 'Salesforce',
name: 'salesforce',
type: 'boolean',
default: false,
},
],
},
],
},
];
@@ -0,0 +1,313 @@
import type { INodeProperties } from 'n8n-workflow';
export const identifyOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['identify'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create an identity',
action: 'Create an identity',
},
],
default: 'create',
},
];
export const identifyFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* identify:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['identify'],
operation: ['create'],
},
},
},
{
displayName: 'Traits',
name: 'traits',
placeholder: 'Add Trait',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
resource: ['identify'],
operation: ['create'],
},
},
default: {},
options: [
{
name: 'traitsUi',
displayName: 'Trait',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Context',
name: 'context',
placeholder: 'Add Context',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['identify'],
operation: ['create'],
},
},
default: {},
options: [
{
name: 'contextUi',
displayName: 'Context',
values: [
{
displayName: 'Active',
name: 'active',
type: 'boolean',
default: false,
description: 'Whether a user is active',
},
{
displayName: 'IP',
name: 'ip',
type: 'string',
default: '',
description: 'Current users IP address',
},
{
displayName: 'Locale',
name: 'locate',
type: 'string',
default: '',
description: 'Locale string for the current user, for example en-US',
},
{
displayName: 'Page',
name: 'page',
type: 'string',
default: '',
description:
'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
},
{
displayName: 'Timezone',
name: 'timezone',
type: 'string',
default: '',
description:
'Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York',
},
{
displayName: 'App',
name: 'app',
placeholder: 'Add App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'appUi',
displayName: 'App',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
{
displayName: 'Build',
name: 'build',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Campaign',
name: 'campaign',
placeholder: 'Campaign App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'campaignUi',
displayName: 'Campaign',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Source',
name: 'source',
type: 'string',
default: '',
},
{
displayName: 'Medium',
name: 'medium',
type: 'string',
default: '',
},
{
displayName: 'Term',
name: 'term',
type: 'string',
default: '',
},
{
displayName: 'Content',
name: 'content',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Device',
name: 'device',
placeholder: 'Add Device',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'deviceUi',
displayName: 'Device',
values: [
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
},
{
displayName: 'Manufacturer',
name: 'manufacturer',
type: 'string',
default: '',
},
{
displayName: 'Model',
name: 'model',
type: 'string',
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
],
},
],
},
],
},
],
},
{
displayName: 'Integration',
name: 'integrations',
placeholder: 'Add Integration',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['identify'],
operation: ['create'],
},
},
default: {},
options: [
{
name: 'integrationsUi',
displayName: 'Integration',
values: [
{
displayName: 'All',
name: 'all',
type: 'boolean',
default: true,
},
{
displayName: 'Salesforce',
name: 'salesforce',
type: 'boolean',
default: false,
},
],
},
],
},
];
@@ -0,0 +1,10 @@
import type { IDataObject } from 'n8n-workflow';
export interface IIdentify {
userId?: string;
anonymousId?: string;
traits?: IDataObject;
context?: IDataObject;
integrations?: IDataObject;
timestamp?: string;
}
@@ -0,0 +1,18 @@
{
"node": "n8n-nodes-base.segment",
"nodeVersion": "1.0",
"codexVersion": "1.0",
"categories": ["Analytics", "Development"],
"resources": {
"credentialDocumentation": [
{
"url": "https://docs.n8n.io/integrations/builtin/credentials/segment/"
}
],
"primaryDocumentation": [
{
"url": "https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.segment/"
}
]
}
}
@@ -0,0 +1,630 @@
import type {
IExecuteFunctions,
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { NodeConnectionTypes } from 'n8n-workflow';
import { v4 as uuid } from 'uuid';
import { segmentApiRequest } from './GenericFunctions';
import { groupFields, groupOperations } from './GroupDescription';
import { identifyFields, identifyOperations } from './IdentifyDescription';
import type { IIdentify } from './IdentifyInterface';
import { trackFields, trackOperations } from './TrackDescription';
import type { IGroup, ITrack } from './TrackInterface';
export class Segment implements INodeType {
description: INodeTypeDescription = {
displayName: 'Segment',
name: 'segment',
icon: 'file:segment.svg',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ":" + $parameter["resource"]}}',
description: 'Consume Segment API',
defaults: {
name: 'Segment',
},
usableAsTool: true,
inputs: [NodeConnectionTypes.Main],
outputs: [NodeConnectionTypes.Main],
credentials: [
{
name: 'segmentApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Group',
value: 'group',
description: 'Group lets you associate an identified user with a group',
},
{
name: 'Identify',
value: 'identify',
description: 'Identify lets you tie a user to their actions',
},
{
name: 'Track',
value: 'track',
description: 'Track lets you record events',
},
],
default: 'identify',
},
...groupOperations,
...groupFields,
...identifyOperations,
...trackOperations,
...identifyFields,
...trackFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length;
let responseData;
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
for (let i = 0; i < length; i++) {
try {
if (resource === 'group') {
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#group
if (operation === 'add') {
const userId = this.getNodeParameter('userId', i) as string;
const groupId = this.getNodeParameter('groupId', i) as string;
const traits = (this.getNodeParameter('traits', i) as IDataObject)
.traitsUi as IDataObject[];
const context = (this.getNodeParameter('context', i) as IDataObject)
.contextUi as IDataObject;
const integrations = (this.getNodeParameter('integrations', i) as IDataObject)
.integrationsUi as IDataObject;
const body: IGroup = {
groupId,
traits: {
company: {},
address: {},
},
context: {
app: {},
campaign: {},
device: {},
},
integrations: {},
};
if (userId) {
body.userId = userId;
} else {
body.anonymousId = uuid();
}
if (traits) {
if (traits && traits.length !== 0) {
for (const trait of traits) {
body.traits![trait.key as string] = trait.value;
}
}
}
if (context) {
if (context.active) {
body.context!.active = context.active as boolean;
}
if (context.ip) {
body.context!.ip = context.ip as string;
}
if (context.locate) {
body.context!.locate = context.locate as string;
}
if (context.page) {
body.context!.page = context.page as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.app) {
const app = (context.app as IDataObject).appUi as IDataObject;
if (app) {
if (app.name) {
//@ts-ignore
body.context.app.name = app.name as string;
}
if (app.version) {
//@ts-ignore
body.context.app.version = app.version as string;
}
if (app.build) {
//@ts-ignore
body.context.app.build = app.build as string;
}
}
}
if (context.campaign) {
const campaign = (context.campaign as IDataObject).campaignUi as IDataObject;
if (campaign) {
if (campaign.name) {
//@ts-ignore
body.context.campaign.name = campaign.name as string;
}
if (campaign.source) {
//@ts-ignore
body.context.campaign.source = campaign.source as string;
}
if (campaign.medium) {
//@ts-ignore
body.context.campaign.medium = campaign.medium as string;
}
if (campaign.term) {
//@ts-ignore
body.context.campaign.term = campaign.term as string;
}
if (campaign.content) {
//@ts-ignore
body.context.campaign.content = campaign.content as string;
}
}
}
if (context.device) {
const device = (context.device as IDataObject).deviceUi as IDataObject;
if (device) {
if (device.id) {
//@ts-ignore
body.context.device.id = device.id as string;
}
if (device.manufacturer) {
//@ts-ignore
body.context.device.manufacturer = device.manufacturer as string;
}
if (device.model) {
//@ts-ignore
body.context.device.model = device.model as string;
}
if (device.type) {
//@ts-ignore
body.context.device.type = device.type as string;
}
if (device.version) {
//@ts-ignore
body.context.device.version = device.version as string;
}
}
}
}
if (integrations) {
if (integrations.all) {
body.integrations!.all = integrations.all as boolean;
}
if (integrations.salesforce) {
body.integrations!.salesforce = integrations.salesforce as boolean;
}
}
responseData = await segmentApiRequest.call(this, 'POST', '/group', body);
}
}
if (resource === 'identify') {
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#identify
if (operation === 'create') {
const userId = this.getNodeParameter('userId', i) as string;
const context = (this.getNodeParameter('context', i) as IDataObject)
.contextUi as IDataObject;
const traits = (this.getNodeParameter('traits', i) as IDataObject)
.traitsUi as IDataObject[];
const integrations = (this.getNodeParameter('integrations', i) as IDataObject)
.integrationsUi as IDataObject;
const body: IIdentify = {
context: {
app: {},
campaign: {},
device: {},
},
traits: {},
integrations: {},
};
if (userId) {
body.userId = userId;
} else {
body.anonymousId = uuid();
}
if (context) {
if (context.active) {
body.context!.active = context.active as boolean;
}
if (context.ip) {
body.context!.ip = context.ip as string;
}
if (context.locate) {
body.context!.locate = context.locate as string;
}
if (context.page) {
body.context!.page = context.page as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.app) {
const app = (context.app as IDataObject).appUi as IDataObject;
if (app) {
if (app.name) {
//@ts-ignore
body.context.app.name = app.name as string;
}
if (app.version) {
//@ts-ignore
body.context.app.version = app.version as string;
}
if (app.build) {
//@ts-ignore
body.context.app.build = app.build as string;
}
}
}
if (context.campaign) {
const campaign = (context.campaign as IDataObject).campaignUi as IDataObject;
if (campaign) {
if (campaign.name) {
//@ts-ignore
body.context.campaign.name = campaign.name as string;
}
if (campaign.source) {
//@ts-ignore
body.context.campaign.source = campaign.source as string;
}
if (campaign.medium) {
//@ts-ignore
body.context.campaign.medium = campaign.medium as string;
}
if (campaign.term) {
//@ts-ignore
body.context.campaign.term = campaign.term as string;
}
if (campaign.content) {
//@ts-ignore
body.context.campaign.content = campaign.content as string;
}
}
}
if (context.device) {
const device = (context.device as IDataObject).deviceUi as IDataObject;
if (device) {
if (device.id) {
//@ts-ignore
body.context.device.id = device.id as string;
}
if (device.manufacturer) {
//@ts-ignore
body.context.device.manufacturer = device.manufacturer as string;
}
if (device.model) {
//@ts-ignore
body.context.device.model = device.model as string;
}
if (device.type) {
//@ts-ignore
body.context.device.type = device.type as string;
}
if (device.version) {
//@ts-ignore
body.context.device.version = device.version as string;
}
}
}
}
if (integrations) {
if (integrations.all) {
body.integrations!.all = integrations.all as boolean;
}
if (integrations.salesforce) {
body.integrations!.salesforce = integrations.salesforce as boolean;
}
}
if (traits) {
if (traits && traits.length !== 0) {
for (const trait of traits) {
body.traits![trait.key as string] = trait.value;
}
}
}
responseData = await segmentApiRequest.call(this, 'POST', '/identify', body);
}
}
if (resource === 'track') {
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#track
if (operation === 'event') {
const userId = this.getNodeParameter('userId', i) as string;
const event = this.getNodeParameter('event', i) as string;
const context = (this.getNodeParameter('context', i) as IDataObject)
.contextUi as IDataObject;
const integrations = (this.getNodeParameter('integrations', i) as IDataObject)
.integrationsUi as IDataObject;
const properties = (this.getNodeParameter('properties', i) as IDataObject)
.propertiesUi as IDataObject[];
const body: ITrack = {
event,
traits: {},
context: {
app: {},
campaign: {},
device: {},
},
integrations: {},
properties: {},
};
if (userId) {
body.userId = userId;
} else {
body.anonymousId = uuid();
}
if (context) {
if (context.active) {
body.context!.active = context.active as boolean;
}
if (context.ip) {
body.context!.ip = context.ip as string;
}
if (context.locate) {
body.context!.locate = context.locate as string;
}
if (context.page) {
body.context!.page = context.page as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.app) {
const app = (context.app as IDataObject).appUi as IDataObject;
if (app) {
if (app.name) {
//@ts-ignore
body.context.app.name = app.name as string;
}
if (app.version) {
//@ts-ignore
body.context.app.version = app.version as string;
}
if (app.build) {
//@ts-ignore
body.context.app.build = app.build as string;
}
}
}
if (context.campaign) {
const campaign = (context.campaign as IDataObject).campaignUi as IDataObject;
if (campaign) {
if (campaign.name) {
//@ts-ignore
body.context.campaign.name = campaign.name as string;
}
if (campaign.source) {
//@ts-ignore
body.context.campaign.source = campaign.source as string;
}
if (campaign.medium) {
//@ts-ignore
body.context.campaign.medium = campaign.medium as string;
}
if (campaign.term) {
//@ts-ignore
body.context.campaign.term = campaign.term as string;
}
if (campaign.content) {
//@ts-ignore
body.context.campaign.content = campaign.content as string;
}
}
}
if (context.device) {
const device = (context.device as IDataObject).deviceUi as IDataObject;
if (device) {
if (device.id) {
//@ts-ignore
body.context.device.id = device.id as string;
}
if (device.manufacturer) {
//@ts-ignore
body.context.device.manufacturer = device.manufacturer as string;
}
if (device.model) {
//@ts-ignore
body.context.device.model = device.model as string;
}
if (device.type) {
//@ts-ignore
body.context.device.type = device.type as string;
}
if (device.version) {
//@ts-ignore
body.context.device.version = device.version as string;
}
}
}
}
if (integrations) {
if (integrations.all) {
body.integrations!.all = integrations.all as boolean;
}
if (integrations.salesforce) {
body.integrations!.salesforce = integrations.salesforce as boolean;
}
}
if (properties) {
if (properties && properties.length !== 0) {
for (const property of properties) {
body.properties![property.key as string] = property.value;
}
}
}
responseData = await segmentApiRequest.call(this, 'POST', '/track', body);
}
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#page
if (operation === 'page') {
const userId = this.getNodeParameter('userId', i) as string;
const name = this.getNodeParameter('name', i) as string;
const context = (this.getNodeParameter('context', i) as IDataObject)
.contextUi as IDataObject;
const integrations = (this.getNodeParameter('integrations', i) as IDataObject)
.integrationsUi as IDataObject;
const properties = (this.getNodeParameter('properties', i) as IDataObject)
.propertiesUi as IDataObject[];
const body: ITrack = {
name,
traits: {},
context: {
app: {},
campaign: {},
device: {},
},
integrations: {},
properties: {},
};
if (userId) {
body.userId = userId;
} else {
body.anonymousId = uuid();
}
if (context) {
if (context.active) {
body.context!.active = context.active as boolean;
}
if (context.ip) {
body.context!.ip = context.ip as string;
}
if (context.locate) {
body.context!.locate = context.locate as string;
}
if (context.page) {
body.context!.page = context.page as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.app) {
const app = (context.app as IDataObject).appUi as IDataObject;
if (app) {
if (app.name) {
//@ts-ignore
body.context.app.name = app.name as string;
}
if (app.version) {
//@ts-ignore
body.context.app.version = app.version as string;
}
if (app.build) {
//@ts-ignore
body.context.app.build = app.build as string;
}
}
}
if (context.campaign) {
const campaign = (context.campaign as IDataObject).campaignUi as IDataObject;
if (campaign) {
if (campaign.name) {
//@ts-ignore
body.context.campaign.name = campaign.name as string;
}
if (campaign.source) {
//@ts-ignore
body.context.campaign.source = campaign.source as string;
}
if (campaign.medium) {
//@ts-ignore
body.context.campaign.medium = campaign.medium as string;
}
if (campaign.term) {
//@ts-ignore
body.context.campaign.term = campaign.term as string;
}
if (campaign.content) {
//@ts-ignore
body.context.campaign.content = campaign.content as string;
}
}
}
if (context.device) {
const device = (context.device as IDataObject).deviceUi as IDataObject;
if (device) {
if (device.id) {
//@ts-ignore
body.context.device.id = device.id as string;
}
if (device.manufacturer) {
//@ts-ignore
body.context.device.manufacturer = device.manufacturer as string;
}
if (device.model) {
//@ts-ignore
body.context.device.model = device.model as string;
}
if (device.type) {
//@ts-ignore
body.context.device.type = device.type as string;
}
if (device.version) {
//@ts-ignore
body.context.device.version = device.version as string;
}
}
}
}
if (integrations) {
if (integrations.all) {
body.integrations!.all = integrations.all as boolean;
}
if (integrations.salesforce) {
body.integrations!.salesforce = integrations.salesforce as boolean;
}
}
if (properties) {
if (properties && properties.length !== 0) {
for (const property of properties) {
body.properties![property.key as string] = property.value;
}
}
}
responseData = await segmentApiRequest.call(this, 'POST', '/page', body);
}
}
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.message });
continue;
}
throw error;
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}
@@ -0,0 +1,635 @@
import type { INodeProperties } from 'n8n-workflow';
export const trackOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['track'],
},
},
options: [
{
name: 'Event',
value: 'event',
description:
'Record the actions your users perform. Every action triggers an event, which can also have associated properties.',
action: 'Track an event',
},
{
name: 'Page',
value: 'page',
description:
'Record page views on your website, along with optional extra information about the page being viewed',
action: 'Track a page',
},
],
default: 'event',
},
];
export const trackFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* track:event */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['track'],
operation: ['event'],
},
},
},
{
displayName: 'Event',
name: 'event',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['track'],
operation: ['event'],
},
},
description: 'Name of the action that a user has performed',
required: true,
},
{
displayName: 'Context',
name: 'context',
placeholder: 'Add Context',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['track'],
operation: ['event'],
},
},
default: {},
options: [
{
name: 'contextUi',
displayName: 'Context',
values: [
{
displayName: 'Active',
name: 'active',
type: 'boolean',
default: false,
description: 'Whether a user is active',
},
{
displayName: 'IP',
name: 'ip',
type: 'string',
default: '',
description: 'Current users IP address',
},
{
displayName: 'Locale',
name: 'locate',
type: 'string',
default: '',
description: 'Locale string for the current user, for example en-US',
},
{
displayName: 'Page',
name: 'page',
type: 'string',
default: '',
description:
'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
},
{
displayName: 'Timezone',
name: 'timezone',
type: 'string',
default: '',
description:
'Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York',
},
{
displayName: 'App',
name: 'app',
placeholder: 'Add App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'appUi',
displayName: 'App',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
{
displayName: 'Build',
name: 'build',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Campaign',
name: 'campaign',
placeholder: 'Campaign App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'campaignUi',
displayName: 'Campaign',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Source',
name: 'source',
type: 'string',
default: '',
},
{
displayName: 'Medium',
name: 'medium',
type: 'string',
default: '',
},
{
displayName: 'Term',
name: 'term',
type: 'string',
default: '',
},
{
displayName: 'Content',
name: 'content',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Device',
name: 'device',
placeholder: 'Add Device',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'deviceUi',
displayName: 'Device',
values: [
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
},
{
displayName: 'Manufacturer',
name: 'manufacturer',
type: 'string',
default: '',
},
{
displayName: 'Model',
name: 'model',
type: 'string',
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
],
},
],
},
],
},
],
},
{
displayName: 'Integration',
name: 'integrations',
placeholder: 'Add Integration',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['track'],
operation: ['event'],
},
},
default: {},
options: [
{
name: 'integrationsUi',
displayName: 'Integration',
values: [
{
displayName: 'All',
name: 'all',
type: 'boolean',
default: true,
},
{
displayName: 'Salesforce',
name: 'salesforce',
type: 'boolean',
default: false,
},
],
},
],
},
{
displayName: 'Properties',
name: 'properties',
placeholder: 'Add Properties',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
resource: ['track'],
operation: ['event'],
},
},
default: {},
options: [
{
name: 'propertiesUi',
displayName: 'Property',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
/* -------------------------------------------------------------------------- */
/* track:page */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['track'],
operation: ['page'],
},
},
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['track'],
operation: ['page'],
},
},
description:
'Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel',
},
{
displayName: 'Context',
name: 'context',
placeholder: 'Add Context',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['track'],
operation: ['page'],
},
},
default: {},
options: [
{
name: 'contextUi',
displayName: 'Context',
values: [
{
displayName: 'Active',
name: 'active',
type: 'boolean',
default: false,
description: 'Whether a user is active',
},
{
displayName: 'IP',
name: 'ip',
type: 'string',
default: '',
description: 'Current users IP address',
},
{
displayName: 'Locale',
name: 'locate',
type: 'string',
default: '',
description: 'Locale string for the current user, for example en-US',
},
{
displayName: 'Page',
name: 'page',
type: 'string',
default: '',
description:
'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
},
{
displayName: 'Timezone',
name: 'timezone',
type: 'string',
default: '',
description:
'Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York',
},
{
displayName: 'App',
name: 'app',
placeholder: 'Add App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'appUi',
displayName: 'App',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
{
displayName: 'Build',
name: 'build',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Campaign',
name: 'campaign',
placeholder: 'Campaign App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'campaignUi',
displayName: 'Campaign',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Source',
name: 'source',
type: 'string',
default: '',
},
{
displayName: 'Medium',
name: 'medium',
type: 'string',
default: '',
},
{
displayName: 'Term',
name: 'term',
type: 'string',
default: '',
},
{
displayName: 'Content',
name: 'content',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Device',
name: 'device',
placeholder: 'Add Device',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'deviceUi',
displayName: 'Device',
values: [
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
},
{
displayName: 'Manufacturer',
name: 'manufacturer',
type: 'string',
default: '',
},
{
displayName: 'Model',
name: 'model',
type: 'string',
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
],
},
],
},
],
},
],
},
{
displayName: 'Integration',
name: 'integrations',
placeholder: 'Add Integration',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: ['track'],
operation: ['page'],
},
},
default: {},
options: [
{
name: 'integrationsUi',
displayName: 'Integration',
values: [
{
displayName: 'All',
name: 'all',
type: 'boolean',
default: true,
},
{
displayName: 'Salesforce',
name: 'salesforce',
type: 'boolean',
default: false,
},
],
},
],
},
{
displayName: 'Properties',
name: 'properties',
placeholder: 'Add Properties',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
resource: ['track'],
operation: ['page'],
},
},
default: {},
options: [
{
name: 'propertiesUi',
displayName: 'Property',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
];
@@ -0,0 +1,17 @@
import type { IDataObject } from 'n8n-workflow';
export interface ITrack {
event?: string;
userId?: string;
name?: string;
anonymousId?: string;
traits?: IDataObject;
context?: IDataObject;
timestamp?: string;
properties?: IDataObject;
integrations?: IDataObject;
}
export interface IGroup extends ITrack {
groupId: string;
}
@@ -0,0 +1,9 @@
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
},
"version": 1
}
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fill="#fff" fill-rule="evenodd" stroke="#000" stroke-linecap="round" stroke-linejoin="round" viewBox="0 0 65 61"><use xlink:href="#a" x=".5" y=".5"/><symbol id="a" overflow="visible"><g fill-rule="nonzero" stroke="none"><path fill="#99cfac" d="M39.875 40.567H3.073C1.383 40.567 0 39.184 0 37.493s1.383-3.073 3.073-3.073h36.802c1.69 0 3.073 1.383 3.073 3.073s-1.383 3.073-3.073 3.073z"/><path fill="#49b881" d="M32.038 59.39c-2.996 0-5.993-.461-8.836-1.306-1.613-.538-2.535-2.228-1.998-3.842s2.228-2.535 3.842-1.998a23.7 23.7 0 0 0 6.992 1.076c10.449 0 19.515-6.684 22.511-16.672.461-1.614 2.228-2.535 3.842-2.074s2.535 2.228 2.074 3.842C56.547 50.939 45.176 59.39 32.038 59.39"/><path fill="#99cfac" d="M60.927 24.971H24.125c-1.69 0-3.073-1.383-3.073-3.073s1.383-3.073 3.073-3.073h36.802c1.69 0 3.073 1.383 3.073 3.073s-1.383 3.073-3.073 3.073"/><path fill="#49b881" d="M6.531 24.97c-.307 0-.615-.077-.922-.154-1.613-.461-2.535-2.228-2.074-3.841C7.453 8.451 18.824 0 32.039 0c2.996 0 5.993.461 8.835 1.306 1.613.538 2.535 2.228 1.998 3.842s-2.228 2.535-3.842 1.998a23.7 23.7 0 0 0-6.992-1.076c-10.449 0-19.515 6.684-22.511 16.672-.461 1.383-1.69 2.228-2.996 2.228"/><g fill="#99cfac"><use xlink:href="#b"/><use xlink:href="#b" x="-36.495" y="39.03"/></g></g></symbol><defs><path id="b" d="M47.174 10.218c0-1.703 1.371-3.073 3.073-3.073s3.073 1.371 3.073 3.073-1.371 3.073-3.073 3.073-3.073-1.371-3.073-3.073"/></defs></svg>

After

Width:  |  Height:  |  Size: 1.5 KiB