Get Segment
customer_io.get_segment
ActionCRM & salesconnection required
Calls the Customer.io API with the connection's credentials.
Read one segment's metadata, type and current build state.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Customer.io
- Secret shape
- {"site_id": "…", "api_key": "…", "app_api_key": "…"} — the Site ID and Track API key for the Track nodes, the App API key for the rest
- Config it needs
- region, workspace_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
segment_id The numeric id of the segment, from its page in the dashboard under Usage. | string | Yes | — | — | 12 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"segment_id": "12"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The segment's numeric id. | number | — |
name The segment name. | string | — |
description The segment description, when one is set. | string | — |
state The build state of the segment, such as 'finished'. | string | — |
progress How far a rebuilding segment has got, as a percentage. | number | — |
type 'manual' for an API-managed segment, 'dynamic' otherwise. | string | — |
created_at When the segment was created, as a Unix timestamp. | number | — |
updated_at When the segment last changed, as a Unix timestamp. | number | — |
{
"created_at": 0,
"description": "",
"id": 0,
"name": "",
"progress": 0,
"state": "",
"type": "",
"updated_at": 0
}See Get Segment run in a workflow.
In a technical demo we add the Customer.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.