Create Ticket

freshservice.create_ticket
ActionBusiness appsconnection required

Calls the Freshservice API with the connection's credentials.

Raise a Freshservice ticket for a requester named by email or user id.

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.

FieldTypeRequiredDefaultConstraintsExample
subject
Subject line of the record.
stringNo——Unable to reach the email server
description
Body of the ticket; Freshservice stores and renders it as HTML.
stringYes———
email
Email address of the requester; Freshservice adds a contact when it does not know it yet.
stringNo—email formattom@outerspace.com
requester_id
Numeric user id of an existing requester, used instead of their email address.
stringNo———
priority
Priority: 1 Low, 2 Medium, 3 High, 4 Urgent.
numberNo—1–42
status
Ticket status: 2 Open, 3 Pending, 4 Resolved, 5 Closed.
numberNo—2–52
source
Channel the ticket came in through, as a Freshservice source id (2 Portal, 3 Phone, 9 Walkup).
numberNo—1–18—
urgency
Urgency: 1 Low, 2 Medium, 3 High.
numberNo—1–3—
impact
Impact: 1 Low, 2 Medium, 3 High.
numberNo—1–3—
group_id
Numeric id of the agent group the record is assigned to.
stringNo———
responder_id
Numeric id of the agent the ticket is assigned to.
stringNo———
department_id
Numeric id of the department the record belongs to.
stringNo———
category
Category name for the record, as configured in this Freshservice account.
stringNo———
tags
Tags to attach to the ticket, as a JSON array.
arrayNo—array of string—
cc_emails
Addresses to copy on the ticket, as a JSON array.
arrayNo—array of string—
custom_fields
Custom field values as a JSON object keyed by the field's Freshservice name.
objectNo———
workspace_id
Workspace to act in; defaults to the connection's workspace, then the primary one. Only accounts on the workspaces plan use it.
stringNo———
attributes
Any other documented attribute for this record, as a JSON object merged into the request.
objectNo———
  • 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,
  "status": 2,
  "subject": "Unable to reach the email server"
}

Output

One shape.

result

FieldTypeExample
id
Numeric id of the ticket.
number—
subject
Subject line of the ticket.
string—
status
Status: 2 Open, 3 Pending, 4 Resolved, 5 Closed.
number—
priority
Priority: 1 Low, 2 Medium, 3 High, 4 Urgent.
number—
urgency
Urgency of the ticket, 1 Low to 3 High.
number—
impact
Impact of the ticket, 1 Low to 3 High.
number—
requester_id
User id of the requester the ticket belongs to.
number—
responder_id
User id of the agent the ticket is assigned to.
number—
group_id
Id of the agent group the ticket is assigned to.
number—
department_id
Id of the department the requester belongs to.
number—
type
Ticket type, such as Incident or Service Request.
string—
source
Channel the ticket came in through, as a Freshservice source id.
number—
description_text
Plain-text rendering of the ticket description.
string—
due_by
When the ticket is due to be resolved.
string—
fr_due_by
When the first response on the ticket is due.
string—
tags
Tags associated with the ticket.
array—
workspace_id
Workspace the ticket belongs to.
number—
created_at
When the ticket was created.
string—
updated_at
When the ticket was last updated.
string—
{
  "created_at": "",
  "department_id": 0,
  "description_text": "",
  "due_by": "",
  "fr_due_by": "",
  "group_id": 0,
  "id": 0,
  "impact": 0,
  "priority": 0,
  "requester_id": 0,
  "responder_id": 0,
  "source": 0,
  "status": 0,
  "subject": "",
  "tags": [],
  "type": "",
  "updated_at": "",
  "urgency": 0,
  "workspace_id": 0
}

Notes

  • Freshservice creates a contact for an email address it does not know yet.

See Create Ticket 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.