User Metadata Integration

User metadata integration provides the ability to add user metadata created through the support service to cards.

Kaiten requests metadata from your custom metadata service.

Connection setup

To setup go to Service Desk -> Settings and enter url and token in block Meta-information receive settings.

Endpoint description

POST

URL you specified in the setting

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "email": {
   "type": "string",
   "description": "User email"
  },
  "token": {
   "oneOf": [
    {
     "type": "string",
     "description": "Access token"
    },
    {
     "type": "null",
     "description": "Empty acess token"
    }
   ]
  }
 },
 "required": [
  "email"
 ]
}

Name	Type	Description
email required	string	User email
token	string	Access token
token	null	Empty acess token

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id_{propertyId}	string \| integer \| null \| object	Card custom property
description	number \| string	Description for card

If the response contains attributes other than those specified, they will be ignored.

If the response contains non-validated data, the metadata will not be added.

get custom_property_id

custom_property_id examples

Error handling

Responses with an HTTP code other than 200 are stored in a comment to the request. If the data from the response does not pass the check, then the error message is also stored in the note to the request:

User Metadata Integration

User metadata integration provides the ability to add user metadata created through the support service to cards.

Kaiten requests metadata from your custom metadata service.

Connection setup

Endpoint description

Headers

Attributes

Responses

Response Attributes

If the response contains attributes other than those specified, they will be ignored.

If the response contains non-validated data, the metadata will not be added.

Error handling

Responses with an HTTP code other than 200 are stored in a comment to the request. If the data from the response does not pass the check, then the error message is also stored in the note to the request:

Kaiten

If you have any questions or need help with integration feel free to write us at support@kaiten.io