Create Journey
Creates a Journey in the given Engage space. Accepts an XState journey definition and creates the journey in draft state.
• This endpoint is in Alpha testing. Please submit any feedback by sending an email to friends@segment.com.
Securitytoken
Request
Request Body schema: application/vnd.segment.v1alpha+jsonrequired
Responses
200
OK
404
Resource not found
422
Validation failure
429
Too many requests
post/spaces/{spaceId}/journeys
Request samples
- Payload
- TypeScript
- Java
- Python
- Go
- curl
application/vnd.segment.v1alpha+json
{- "name": "Application Abandonment",
- "description": "Calls users who abandon an application within 20 minutes",
- "definition": {
- "initial": "entry_abc123",
- "states": {
- "entry_abc123": {
- "meta": {
- "type": "entry",
- "name": "Application Started",
- "event": {
- "type": "ast",
- "options": {
- "AND": [
- {
- "event": "Application Started"
}
]
}
}
}, - "on": {
- "hold_abc123": {
- "target": "hold_abc123"
}
}
}, - "hold_abc123": {
- "meta": {
- "type": "split",
- "name": "Wait for Application Finished",
- "splitType": "event",
- "delay": {
- "duration": 20,
- "durationUnits": "minutes"
}
}, - "on": {
- "completed_abc123": {
- "target": "exit_completed_abc123"
}, - "timeout_abc123": {
- "target": "exit_timeout_abc123"
}
}
}, - "exit_completed_abc123": {
- "meta": {
- "type": "exit",
- "name": "Completed"
}
}, - "exit_timeout_abc123": {
- "meta": {
- "type": "exit",
- "name": "Timed Out"
}
}
}, - "entryRules": {
- "type": "multiple"
}
}
}Response samples
- 200
- 404
- 422
- 429
application/vnd.segment.v1alpha+json
{- "data": {
- "journey": {
- "id": "jou_0ujsszwN8NRY24YaXiTIE2VWDTS",
- "spaceId": "9aQ1Lj62S4bomZKLF4DPqW",
- "name": "Application Abandonment",
- "executionState": "DRAFT",
- "createdAt": "2006-01-02T15:04:05.000Z",
- "updatedAt": "2006-01-02T15:04:05.000Z"
}
}
}