Create Change
freshservice.create_change
ActionBusiness appsconnection required
Calls the Freshservice API with the connection's credentials.
Raise a Freshservice change request for a requester.
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
18 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 change request. | string | Yes | — | — | — |
description Body of the record; Freshservice stores and renders it as HTML. | string | No | — | — | — |
email Email address of the requester; Freshservice adds a contact when it does not know it yet. | string | No | — | email format | tom@outerspace.com |
requester_id Numeric user id of an existing requester, used instead of their email address. | string | No | — | — | — |
priority Priority: 1 Low, 2 Medium, 3 High, 4 Urgent. | number | No | — | 1–4 | 2 |
status Change status: 1 Open, 2 Planning, 3 Approval, 4 Pending Release, 5 Pending Review, 6 Closed. | number | No | — | 1–6 | — |
impact Impact: 1 Low, 2 Medium, 3 High. | number | No | — | 1–3 | — |
risk Risk of the change: 1 Low, 2 Medium, 3 High, 4 Very High. | number | No | — | 1–4 | — |
change_type Type of the change: 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 | — | — | — |
- At least one of email, requester_id must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email": "tom@outerspace.com",
"priority": 2
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id Numeric id of the change request. | number | — |
subject Subject line of the change. | string | — |
status Status, 1 Open through 6 Closed. | number | — |
priority Priority: 1 Low, 2 Medium, 3 High, 4 Urgent. | number | — |
impact Impact: 1 Low, 2 Medium, 3 High. | number | — |
risk Risk: 1 Low, 2 Medium, 3 High, 4 Very High. | number | — |
change_type Type: 1 Minor, 2 Standard, 3 Major, 4 Emergency. | number | — |
approval_status Where the change stands in its approval workflow. | number | — |
requester_id User id of whoever raised the change. | number | — |
agent_id User id of the agent the change is assigned to. | number | — |
group_id Id of the agent group the change is assigned to. | number | — |
planned_start_date When the change is planned to start. | string | — |
planned_end_date When the change is planned to end. | string | — |
workspace_id Workspace the change belongs to. | number | — |
created_at When the change was created. | string | — |
updated_at When the change was last updated. | string | — |
{
"agent_id": 0,
"approval_status": 0,
"change_type": 0,
"created_at": "",
"group_id": 0,
"id": 0,
"impact": 0,
"planned_end_date": "",
"planned_start_date": "",
"priority": 0,
"requester_id": 0,
"risk": 0,
"status": 0,
"subject": "",
"updated_at": "",
"workspace_id": 0
}Notes
- Freshservice treats priority, status, impact, risk and change_type as mandatory on a change.
See Create Change 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.