Zendesk

Add Internal Note to Zendesk Ticket

Adds a private note that only agents can see.

Unverified

What the model is told

Add an internal note to an existing Zendesk ticket, for example a summary of the conversation for the agent who picks it up. The customer does not see it. Only use a ticket ID the customer has given you or you have just created.

Request

PUThttps://YOUR_SUBDOMAIN.zendesk.com/api/v2/tickets/{{ticketId}}.json

Headers

  • Content-Typeapplication/json
  • AuthorizationBasic YOUR_BASE64_EMAIL_SLASH_TOKEN_AND_API_TOKEN

Body

{
  "ticket": {
    "comment": {
      "body": "{{note}}",
      "public": false
    }
  }
}

Parameters

  • ticketId numberThe numeric ticket ID.
  • note stringThe note text for agents.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "70b8bf8c-6755-4ea5-b260-fe2d79518ea6",
    "type": "HTTP_REQUEST",
    "label": "Add Internal Note to Zendesk Ticket",
    "name": "add_internal_note_to_zendesk_ticket",
    "customName": false,
    "description": "Add an internal note to an existing Zendesk ticket, for example a summary of the conversation for the agent who picks it up. The customer does not see it. Only use a ticket ID the customer has given you or you have just created.",
    "parameters": [
      {
        "name": "ticketId",
        "type": "number",
        "description": "The numeric ticket ID."
      },
      {
        "name": "note",
        "type": "string",
        "description": "The note text for agents."
      }
    ],
    "config": {
      "endpoint": {
        "method": "PUT",
        "url": "https://YOUR_SUBDOMAIN.zendesk.com/api/v2/tickets/{{ticketId}}.json"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Basic YOUR_BASE64_EMAIL_SLASH_TOKEN_AND_API_TOKEN"
        }
      ],
      "body": "{\n  \"ticket\": {\n    \"comment\": {\n      \"body\": \"{{note}}\",\n      \"public\": false\n    }\n  }\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.