Skip to content

Segment

Node: segment · Full type: n8n-nodes-base.segment · Version: 1

Credentials

segmentApi (alias: @segment)

CREDENTIAL @segment = segmentApi "My Segment"

Operations

Resource: group

add

Parameter Type Default Details
userId string ""
groupId string "" required
traits fixedCollection {} groups: traitsUi
context fixedCollection {} groups: contextUi
integrations fixedCollection {} groups: integrationsUi

Resource: identify

create

Parameter Type Default Details
userId string ""
traits fixedCollection {} groups: traitsUi
context fixedCollection {} groups: contextUi
integrations fixedCollection {} groups: integrationsUi

Resource: track

event

Parameter Type Default Details
userId string ""
event string "" required
context fixedCollection {} groups: contextUi
integrations fixedCollection {} groups: integrationsUi
properties fixedCollection {} groups: propertiesUi

page

Parameter Type Default Details
userId string ""
name string ""
context fixedCollection {} groups: contextUi
integrations fixedCollection {} groups: integrationsUi
properties fixedCollection {} groups: propertiesUi

Parameter Details

traits children:

traitsUi group:

Parameter Type Default Details
key string ""
value string ""

context children:

contextUi group:

Parameter Type Default Details
active boolean false
ip string ""
locate string ""
page string ""
timezone string ""
app fixedCollection {} groups: appUi
campaign fixedCollection {} groups: campaignUi
device fixedCollection {} groups: deviceUi

integrations children:

integrationsUi group:

Parameter Type Default Details
all boolean true
salesforce boolean false

properties children:

propertiesUi group:

Parameter Type Default Details
key string ""
value string ""

Example

NODE "segment" @segment AS "Segment" {
  resource: "group",
  operation: "create",
  groupId: {{ $json.groupId }},
  event: {{ $json.event }}
}