FlowmageDocs

Add note

BetaChanges data

Adds a private or public note to a Freshdesk ticket.

Settings

SettingWhat it is
ConnectionRequiredThe Freshdesk connection the step signs in with.
Ticket idRequiredtext
Note formatFreshdesk renders a note as HTML. Plain text escapes what you write and turns your line breaks into HTML ones.
NoteRequiredtext
PrivateOn, only agents see it. Off, the requester sees it in the portal — Freshdesk still does not e-mail anyone unless you fill Notify.
NotifyFreshdesk e-mails these addresses about the note.
Add as agent idtext
Mark as coming from the requesterRecords the note as if the requester wrote it, rather than an agent.
AttachmentsFile name → its base64, for example {{ file("report.pdf").base64 }}. All attachments together may not exceed 20 MB.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `freshdesk`)
ticketIdtext
bodyFormat"text" or "html", by default "text"
bodytext
privatetrue/false, by default true
notifyEmailstext
userIdtext
incomingtrue/false, by default false
attachmentsobject of text, by default {}

Output

FieldType
conversationIdNote idnumber
conversationNoteobject
Sample output, and the expression for each field
  • conversation{}
  • conversationId6

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "attachments": {},
    "body": "<note>",
    "bodyFormat": "text",
    "connection": "<connection id>",
    "incoming": false,
    "notifyEmails": "",
    "private": true,
    "ticketId": "<ticket id>",
    "userId": ""
  },
  "label": "Add note",
  "type": "freshdesk.addNote",
  "version": 1
}