Skip to main content
POST
/
get-configurations
curl --request POST \
--url https://api.heify.com/get-configurations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}'
{
"configuration": {
"client_id": "client-12345",
"configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"tag": "Customer Support - Technical Issues",
"vocabulary": [
"firewall",
"VPN"
],
"extraction_fields": [
{
"name": "ticket_id",
"type": "string",
"description": "The support ticket number mentioned."
}
],
"webhooks": {
"success_url": "https://myservice.com/webhooks/success",
"error_url": "https://myservice.com/webhooks/error"
},
"summary": true,
"summary_language": "en",
"analytics_language": "en",
"created_at": "2023-10-27T10:00:00Z"
}
}
For a detailed explanation of the Configuration and its parameters, please consult the Configuration Object.

Authorizations

x-api-key
string
header
required

Body

application/json

To retrieve a specific configuration, provide its configuration_id. To retrieve all configurations, send an empty JSON object: {}.

configuration_id
string

The unique identifier of the configuration to retrieve. Omit to retrieve all configurations.

Response

200 - application/json

Successfully retrieved configuration(s). The response structure depends on whether a single configuration or all of them were requested.

  • Option 1
  • Option 2
configuration
object