Tickets

Get Ticket Form by ID

GET https://api.clearfeed.app/v1/rest/tickets/forms/:id

Retrieves detailed information about a ticket form by its ID, including the form's configuration, fields, and integration type.

Path Parameters

Name	Type	Description
id*	integer	The unique identifier of the form

Response

Returns a ticket form object with the following properties:

Name	Type	Description
id	integer	The unique identifier of the form
name	string	The display name of the form
description	string	The description of the form (can be null)
action_config	object	Configuration object containing the form's actions and field definitions
created_at	string	The creation timestamp of the form
updated_at	string	The update timestamp of the form
integration_type	string	The type of integration this form is associated with

Example cURL Request

curl --location 'https://api.clearfeed.app/v1/rest/tickets/forms/789' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Response

200: OK

{
  "ticket_form": {
    "id": 789,
    "name": "Customer Support Request",
    "description": "Standard support ticket form for customer inquiries",
    "action_config": {
      "create": {
        "enabled": true,
        "fields": [
          {
            "key": "subject",
            "audience": "all",
            "is_hidden": false,
            "required_by_responder": true,
            "required_by_non_responder": true
          },
          {
            "key": "description",
            "audience": "all",
            "is_hidden": false,
            "required_by_responder": true,
            "required_by_non_responder": true
          }
        ]
      }
    },
    "created_at": "2025-01-03T05:38:21.836Z",
    "updated_at": "2025-08-19T12:38:32.872Z",
    "integration_type": "zendesk"
  }
}

404: Not Found

{
  "message": "Ticket form with id 789 not found",
  "error": "NOT_FOUND"
}

Notes

• This endpoint returns form details only for forms that belong to the authenticated account

• The action_config object contains the form's field definitions and validation rules

• Use this endpoint when you receive a form_id in the Requests API to get the full form details

Link Ticket to Request

POST https://api.clearfeed.app/v1/rest/tickets

Links an external ticket to a ClearFeed request using the message ID, the ID of a monitored Slack channel, and the ticket details.

Request Body

Name	Type	Description
type*	string	The type of ticket action to perform. Must be link.
data*	object	Contains the ticket linking information. See Link Ticket Data Object for details.

Link Ticket Data Object

Name	Type	Description
integration*	string	The external ticketing integration name. Currently, the only supported value is zendesk.
ticket_id*	string	The ID of the ticket in the external system.
message_ts*	string	The unique identifier (timestamp) of the Slack message to link with the ticket (e.g., "1750828950.739009").
channel_id*	string	The monitored Slack channel ID where the message exists (e.g., "C05UGMKEHHN").
message_source*	string	The source of the message. Currently, the only supported value is slack_channel.

Example Request Body

{
  "type": "link",
  "data": {
    "integration": "zendesk",
    "ticket_id": "7818",
    "message_ts": "1750828950.739009",
    "channel_id": "C05UGMKEHHN",
    "message_source": "slack_channel"
  }
}

Example cURL Request

curl --location 'https://api.clearfeed.app/v1/rest/tickets' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data-raw '{
  "type": "link",
  "data": {
    "integration": "zendesk",
    "ticket_id": "7818",
    "message_ts": "1750828950.739009",
    "channel_id": "C05UGMKEHHN",
    "message_source": "slack_channel"
  }
}'

Response

201: Created

The ticket was successfully linked. The API returns an empty body on success.

400: Bad Request

{
  // Error message varies based on the specific validation failure
  "message": "The message with timestamp '1750828950.739009' from Slack channel 'C05UGMKEHHN' is not available in ClearFeed",
  "error": "BAD_REQUEST"
}

Notes

• The message_ts is the unique identifier (timestamp) for a Slack message in a monitored channel.

• The channel_id must be a valid Slack channel ID that is being monitored by ClearFeed.

• Currently, only Zendesk integration is supported for linking tickets.

• The API will validate that the message exists and is associated with a ClearFeed request before creating the link.