Skip to content

Commit 098776b

Browse files
ellicenelsonclaude
andauthored
Document CX Score attributes in custom_attributes schema (#446)
The "CX Score rating" and "CX Score explanation" conversation attributes are already returned in the API but were not mentioned in the OpenAPI spec. This adds them to the custom_attributes description and examples across versions 2.13, 2.14, 2.15, and Preview. Closes intercom/intercom#433818 Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent a9a3759 commit 098776b

4 files changed

Lines changed: 17 additions & 4 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22889,7 +22889,8 @@ components:
2288922889
type: object
2289022890
description: An object containing the different custom attributes associated
2289122891
to the conversation as key-value pairs. For relationship attributes the value
22892-
will be a list of custom object instance models.
22892+
will be a list of custom object instance models. System-defined attributes
22893+
such as "CX Score rating" and "CX Score explanation" may also be included.
2289322894
additionalProperties:
2289422895
anyOf:
2289522896
- type: string
@@ -22902,6 +22903,9 @@ components:
2290222903
team_mates: 9
2290322904
start_date_iso8601: "2023-03-04T09:46:14Z"
2290422905
end_date_timestamp: 1677923174
22906+
CX Score rating: 4
22907+
CX Score explanation: The conversation was resolved quickly and the customer
22908+
expressed satisfaction with the outcome.
2290522909
custom_object_instance:
2290622910
title: Custom Object Instance
2290722911
type: object

descriptions/2.13/api.intercom.io.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16933,7 +16933,8 @@ components:
1693316933
type: object
1693416934
description: An object containing the different custom attributes associated
1693516935
to the conversation as key-value pairs. For relationship attributes the value
16936-
will be a list of custom object instance models.
16936+
will be a list of custom object instance models. System-defined attributes
16937+
such as "CX Score rating" and "CX Score explanation" may also be included.
1693716938
additionalProperties:
1693816939
anyOf:
1693916940
- type: string

descriptions/2.14/api.intercom.io.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18593,7 +18593,8 @@ components:
1859318593
type: object
1859418594
description: An object containing the different custom attributes associated
1859518595
to the conversation as key-value pairs. For relationship attributes the value
18596-
will be a list of custom object instance models.
18596+
will be a list of custom object instance models. System-defined attributes
18597+
such as "CX Score rating" and "CX Score explanation" may also be included.
1859718598
additionalProperties:
1859818599
anyOf:
1859918600
- type: string
@@ -18606,6 +18607,9 @@ components:
1860618607
team_mates: 9
1860718608
start_date_iso8601: "2023-03-04T09:46:14Z"
1860818609
end_date_timestamp: 1677923174
18610+
CX Score rating: 4
18611+
CX Score explanation: The conversation was resolved quickly and the customer
18612+
expressed satisfaction with the outcome.
1860918613
custom_object_instance:
1861018614
title: Custom Object Instance
1861118615
type: object

descriptions/2.15/api.intercom.io.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19320,7 +19320,8 @@ components:
1932019320
type: object
1932119321
description: An object containing the different custom attributes associated
1932219322
to the conversation as key-value pairs. For relationship attributes the value
19323-
will be a list of custom object instance models.
19323+
will be a list of custom object instance models. System-defined attributes
19324+
such as "CX Score rating" and "CX Score explanation" may also be included.
1932419325
additionalProperties:
1932519326
anyOf:
1932619327
- type: string
@@ -19333,6 +19334,9 @@ components:
1933319334
team_mates: 9
1933419335
start_date_iso8601: "2023-03-04T09:46:14Z"
1933519336
end_date_timestamp: 1677923174
19337+
CX Score rating: 4
19338+
CX Score explanation: The conversation was resolved quickly and the customer
19339+
expressed satisfaction with the outcome.
1933619340
custom_object_instance:
1933719341
title: Custom Object Instance
1933819342
type: object

0 commit comments

Comments
 (0)