customerIo.json•6.49 kB
{
"nodeType": "n8n-nodes-base.customerIo",
"displayName": "Customer.io",
"description": "Consume Customer.io API",
"version": 1,
"properties": [
{
"name": "campaignId",
"displayName": "Campaign ID",
"type": "number",
"default": 0,
"description": "The unique identifier for the campaign",
"required": true,
"displayOptions": {
"show": {
"resource": [
"campaign"
],
"operation": [
"get"
]
}
}
},
{
"name": "period",
"displayName": "Period",
"type": "options",
"default": "days",
"description": "Specify metric period",
"options": [
{
"name": "Hours",
"value": "hours"
},
{
"name": "Days",
"value": "days"
},
{
"name": "Weeks",
"value": "weeks"
},
{
"name": "Months",
"value": "months"
}
],
"displayOptions": {
"show": {
"resource": [
"campaign"
],
"operation": [
"getMetrics"
]
}
}
},
{
"name": "jsonParameters",
"displayName": "JSON Parameters",
"type": "boolean",
"default": false,
"displayOptions": {
"show": {
"resource": [
"campaign"
],
"operation": [
"getMetrics"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Integer specifying how many steps to return. Defaults to the maximum number of timeperiods available, or 12 when using the months period. Maximum timeperiods available are 24 hours, 45 days, 12 weeks and 120 months",
"placeholder": "Add Field",
"options": [
{
"name": "steps",
"displayName": "Steps",
"type": "number",
"default": 0,
"description": "Integer specifying how many steps to return. Defaults to the maximum number of timeperiods available, or 12 when using the months period. Maximum timeperiods available are 24 hours, 45 days, 12 weeks and 120 months"
}
],
"typeOptions": {
"minValue": 0,
"maxValue": 120
},
"displayOptions": {
"show": {
"resource": [
"campaign"
],
"operation": [
"getMetrics"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "get",
"options": [
{
"name": "Get",
"value": "get"
},
{
"name": "Get Many",
"value": "getAll"
},
{
"name": "Get Metrics",
"value": "getMetrics"
}
],
"displayOptions": {
"show": {
"resource": [
"campaign"
]
}
}
},
{
"name": "id",
"displayName": "ID",
"type": "string",
"default": "",
"description": "The unique identifier for the customer",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customer"
],
"operation": [
"delete"
]
}
}
},
{
"name": "additionalFieldsJson",
"displayName": "Additional Fields",
"type": "json",
"default": "",
"description": "Object of values to set as described <a href=\"https://github.com/agilecrm/rest-api#1-companys---companies-api\">here</a>",
"displayOptions": {
"show": {
"resource": [
"customer"
],
"operation": [
"upsert"
],
"jsonParameters": [
true
]
}
}
},
{
"name": "customerId",
"displayName": "Customer ID",
"type": "string",
"default": "",
"description": "The unique identifier for the customer",
"required": true,
"displayOptions": {
"show": {
"resource": [
"event"
],
"operation": [
"track"
]
}
}
},
{
"name": "eventName",
"displayName": "Event Name",
"type": "string",
"default": "",
"description": "Name of the event to track",
"displayOptions": {
"show": {
"resource": [
"event"
],
"operation": [
"track"
]
}
}
},
{
"name": "segmentId",
"displayName": "Segment ID",
"type": "number",
"default": 0,
"description": "The unique identifier of the segment",
"required": true,
"displayOptions": {
"show": {
"resource": [
"segment"
],
"operation": [
"add",
"remove"
]
}
}
},
{
"name": "customerIds",
"displayName": "Customer IDs",
"type": "string",
"default": "",
"description": "A list of customer IDs to add to the segment",
"required": true,
"displayOptions": {
"show": {
"resource": [
"segment"
],
"operation": [
"add",
"remove"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "customer",
"options": [
{
"name": "Customer",
"value": "customer"
},
{
"name": "Event",
"value": "event"
},
{
"name": "Campaign",
"value": "campaign"
},
{
"name": "Segment",
"value": "segment"
}
]
}
],
"credentialsConfig": [
{
"name": "customerIoApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}