3rd-parties are allowed to store data within Alcmeon and associate it either with user profiles or conversations. This can be done via Custom Fields and the API associated with them.

Create an application

1. Create an application
2. Enable the Custom Field permission

Create a Custom Field

1. As an admnistrator, go to your instance Settings, click on Custom fields in the left-side panel
2. Click on the New button in the top-right corner:

• The label field is mandatory: this is the label that will be displayed in the Alcmeon user interface next to the custom field value for a user profile or a conversation
• The Scope field controls which object the value of the field will be associated with: user or conversation
• The Type* field controls what data can be stored in the field value. Currently, we provide support for the following types: integer, decimal floating point number, boolean, string, email, url, date, datetime, dropdown menu, and multi-choice dropdown menu**
• The Restrict to team field can be used to control which subset of agents will be able to view and interact with the field
• The Description field should control a human-readable description of the field: it will be displayed to Agents

3. Click on Save
4. Save the field id displayed in the first column of the list of custom fields.

Store and retrieve data

Set and Get primitives are exposed as a pair of PUT/GET methods:

• Set user field
• Get user field
• Set conversation field
• Get conversation field

Find a user or conversation identifier