Zammad

Add Note to Zammad Ticket

Adds an internal note to an existing Zammad ticket.

Unverified

What the model is told

Add an internal note to an existing Zammad ticket, for example to record extra detail the customer has just given. Confirm the ticket ID and wording first. The note is only visible to agents.

Request

POSThttps://YOUR_SUBDOMAIN.zammad.com/api/v1/ticket_articles

Headers

  • Content-Typeapplication/json
  • AuthorizationToken token=YOUR_ZAMMAD_API_TOKEN

Body

{
  "ticket_id": "{{ticketId}}",
  "subject": "Note from voice assistant",
  "body": "{{note}}",
  "content_type": "text/plain",
  "type": "note",
  "internal": true,
  "sender": "Agent"
}

Parameters

  • ticketId stringThe Zammad ticket ID.
  • note stringThe text of the note.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "e74503d1-273f-46ff-8389-56d1e80fb691",
    "type": "HTTP_REQUEST",
    "label": "Add Note to Zammad Ticket",
    "name": "add_note_to_zammad_ticket",
    "customName": false,
    "description": "Add an internal note to an existing Zammad ticket, for example to record extra detail the customer has just given. Confirm the ticket ID and wording first. The note is only visible to agents.",
    "parameters": [
      {
        "name": "ticketId",
        "type": "string",
        "description": "The Zammad ticket ID."
      },
      {
        "name": "note",
        "type": "string",
        "description": "The text of the note."
      }
    ],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://YOUR_SUBDOMAIN.zammad.com/api/v1/ticket_articles"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Token token=YOUR_ZAMMAD_API_TOKEN"
        }
      ],
      "body": "{\n  \"ticket_id\": \"{{ticketId}}\",\n  \"subject\": \"Note from voice assistant\",\n  \"body\": \"{{note}}\",\n  \"content_type\": \"text/plain\",\n  \"type\": \"note\",\n  \"internal\": true,\n  \"sender\": \"Agent\"\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.