Collections

Collection Object

Collections are represented as JSON object with the following properties

Name	Type	Description
id	integer	The ID of the collection.
name	string	The name of the collection.
created_by	string	ID of the user who created the collection.
config	object	Details about the object can be found here.
emoji_config	object	Details about the object can be found here.
ticketing_config	object	Details about the object can be found here.
csat_config	object	Details about the object can be found here.
created_at	string	The creation timestamp of the request
updated_at	string	The update timestamp of the request

Config Object

Config Object

Config is represented as JSON object with the following properties

Name	Type	Description
story_detection	boolean	Indicates if story detection is enabled
force_story_request	boolean	Indicates if forcing story request is enabled
auto_assign	object	Object containing auto assign information
responders	array	Array of responder objects. The following two types of objects are possible : { "responder_type": "users", "value": [ "U038DHU0J6A" ] } { "responder_type": "domains", "value": [ "clearfeed.ai" ] }

Emoji Config Object

Emoji Config is represented as JSON objects with the following properties

Name	Type	Description
emoji_names	object	Object containing config for all emojis that are setup at the collection level. It has the following properties. For all emojis setup, there'll be a key with the same emoji_name, and value as the config object for the same emoji. Name Type Description emoji_name object Object containing action and config info for the emoji action: Type of action (assign or solved) enabled: Indicates if the action is enabled "action_config": { "apply_on_request_channel": "boolean" }

Ticketing Config Object

Ticket Config is represented as JSON object with the following properties

Name	Type	Description
enabled	boolean	Indicates if the feature is enabled
integration	string	The integration being used
method	object	Object containing method information. emoji: Name of the emoji used (if method is emoji) type: Type of method ("emoji" or "automatic")

CSAT Config Object

CSAT Config is represented as JSON object with the following properties

Name	Type	Description
enabled	boolean	Indicates if the feature is enabled
trigger_rules	array	Array of trigger rules. If there are no rules selected, then CSAT will be triggerred for all REQUESTS. Current possible rules are : {"name" : "tickets_only"}
trigger_type	string	Type of trigger (automatic or manual)
survey_config	object	Object containing survey configuration information survey_type: Type of survey (e.g., five_point_rating)

Get Collections

GET https://api.clearfeed.app/v1/rest/collections

Get all collections in your account

200

{
  "collections": [
    {
      "id": 1,
      "name": "premeium customers",
      "created_by": "U05HGPBRZJN",
      "created_at": "2023-01-01T00:00:00.000Z",
      "updated_at": "2023-01-01T00:00:00.000Z",
      "config": {
        "story_detection": false,
        "force_story_request": true,
        "auto_assign": {
          "enabled": false
        },
        "responders": [
          {
            "responder_type": "users",
            "value": [
              "U038DHU0J6A"
            ]
          }
        ]
      },
      "emoji_config": {
        "emoji_names": {
          "eyes": {
            "action": "assign",
            "enabled": true,
            "action_config": {
              "apply_on_request_channel": true
            }
          },
          "white_check_mark": {
            "action": "solved",
            "enabled": true,
            "action_config": {
              "apply_on_request_channel": true
            }
          }
        }
      },
      "csat_config": {
        "enabled": true,
        "trigger_rules": [],
        "trigger_type": "automatic",
        "survey_config": {
          "survey_type": "five_point_rating"
        }
      },
      "ticketing_config": {
        "enabled": true,
        "integration": "zendesk",
        "method": {
          "emoji": "ticket",
          "type": "emoji"
        }
      }
    }
  ]
}

403: Forbidden Permission denied

Add Channels to a Collection

Channels Object

Name	Type	Description
id	string	Id of the channel that needs to be added to the collection
owner	string	User Id of the primary individual responsible for the channel

Example

{
 "id" : "C01AB2CD1T", 
 "owner": "U038DHU0J6A" 
}

POST https://api.clearfeed.app/v1/rest/collections/:id/channels

Add and start monitoring channels by adding them to a collection

Request Body

Name	Type	Description
channels*	Array	This will be an array of objects with the schema as specified here.

201: Created Channels successfully added to collections