Create Release
freshservice.create_release
ActionBusiness appsconnection required
Calls the Freshservice API with the connection's credentials.
Raise a Freshservice release record.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Freshservice
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- domain, workspace_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
14 fields, 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 |
|---|---|---|---|---|---|
subject Subject line of the release. | string | Yes | — | — | — |
description Body of the record; Freshservice stores and renders it as HTML. | string | No | — | — | — |
priority Priority: 1 Low, 2 Medium, 3 High, 4 Urgent. | number | No | — | 1–4 | 2 |
status Release status: 1 Open, 2 On Hold, 3 In Progress, 4 Incomplete, 5 Completed. | number | No | — | 1–5 | — |
release_type Type of the release: 1 Minor, 2 Standard, 3 Major, 4 Emergency. | number | No | — | 1–4 | — |
planned_start_date Planned start, as a UTC timestamp (YYYY-MM-DDTHH:MM:SSZ). | string | No | — | iso8601 format | — |
planned_end_date Planned end, as a UTC timestamp (YYYY-MM-DDTHH:MM:SSZ). | string | No | — | iso8601 format | — |
agent_id Numeric id of the agent the record is assigned to. | string | No | — | — | — |
group_id Numeric id of the agent group the record is assigned to. | string | No | — | — | — |
department_id Numeric id of the department the record belongs to. | string | No | — | — | — |
category Category name for the record, as configured in this Freshservice account. | string | No | — | — | — |
custom_fields Custom field values as a JSON object keyed by the field's Freshservice name. | object | No | — | — | — |
workspace_id Workspace to act in; defaults to the connection's workspace, then the primary one. Only accounts on the workspaces plan use it. | string | No | — | — | — |
attributes Any other documented attribute for this record, as a JSON object merged into the request. | object | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"priority": 2
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id Numeric id of the release. | number | — |
subject Subject line of the release. | string | — |
status Status, 1 Open through 5 Completed. | number | — |
priority Priority: 1 Low, 2 Medium, 3 High, 4 Urgent. | number | — |
release_type Type: 1 Minor, 2 Standard, 3 Major, 4 Emergency. | number | — |
agent_id User id of the agent the release is assigned to. | number | — |
group_id Id of the agent group the release is assigned to. | number | — |
planned_start_date When the release is planned to start. | string | — |
planned_end_date When the release is planned to end. | string | — |
work_start_date When work on the release actually started. | string | — |
work_end_date When work on the release actually ended. | string | — |
associated_changes Ids of the changes rolled up into this release. | array | — |
workspace_id Workspace the release belongs to. | number | — |
created_at When the release was created. | string | — |
updated_at When the release was last updated. | string | — |
{
"agent_id": 0,
"associated_changes": [],
"created_at": "",
"group_id": 0,
"id": 0,
"planned_end_date": "",
"planned_start_date": "",
"priority": 0,
"release_type": 0,
"status": 0,
"subject": "",
"updated_at": "",
"work_end_date": "",
"work_start_date": "",
"workspace_id": 0
}See Create Release run in a workflow.
In a technical demo we add the Freshservice connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.