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

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. You can link using either:

1. Via Slack Message: Provide message_ts, channel_id, and message_source to identify the request

2. Via Request ID: Provide the ClearFeed request_id directly

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

The data object must include the following required fields, plus one of the following paths for identifying the request:

Always Required Fields (All Paths)

Name	Type	Description
integration*	string	The external ticketing integration name. Supported values: zendesk, clickup.
ticket_id*	string	The ID of the ticket in the external system.

Path 1: Link via Slack Message

Use these fields when linking via Slack message identifiers. Cannot be combined with request_id.

Name	Type	Description
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. Must be: slack_channel.

Path 2: Link via Request ID

Use this field when linking via ClearFeed request ID. Cannot be combined with Slack message fields above.

Name	Type	Description
request_id*	number	The ClearFeed request ID to link the ticket to.

Example Request Body

Link via Slack Message:

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

Link via Request ID:

{
  "type": "link",
  "data": {
    "integration": "clickup",
    "ticket_id": "86ab12cd3",
    "request_id": 12345
  }
}

Example cURL Requests

Link via Slack Message:

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"
  }
}'

Link via Request ID:

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": "clickup",
    "ticket_id": "86ab12cd3",
    "request_id": 12345
  }
}'

Response

201: Created

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

400: Bad Request

Notes

Two Ways to Identify the Request

You must provide exactly one of the following paths to identify which ClearFeed request to link the ticket to:

1. Via Slack Message — Provide all three fields:

   • message_ts — The unique identifier (timestamp) for a Slack message

   • channel_id — Must be a valid Slack channel ID that is being monitored by ClearFeed

   • message_source — Must be "slack_channel"

2. Via Request ID — Provide only:

   • request_id — The ClearFeed request ID (numeric value)

⚠️ Important: Do not mix fields from both paths. The API uses the presence of request_id to determine which validation path to apply.

Supported Integrations

• zendesk — Zendesk tickets

• clickup — ClickUp tasks

The API will validate that the request exists and is accessible before creating the link.