Skip to content

Commit f2c8f03

Browse files
ellicenelsonclaude
andcommitted
Document CX Score attributes in custom_attributes schema
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 60cb1cd commit f2c8f03

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
@@ -22789,7 +22789,8 @@ components:
2278922789
type: object
2279022790
description: An object containing the different custom attributes associated
2279122791
to the conversation as key-value pairs. For relationship attributes the value
22792-
will be a list of custom object instance models.
22792+
will be a list of custom object instance models. System-defined attributes
22793+
such as "CX Score rating" and "CX Score explanation" may also be included.
2279322794
additionalProperties:
2279422795
anyOf:
2279522796
- type: string
@@ -22802,6 +22803,9 @@ components:
2280222803
team_mates: 9
2280322804
start_date_iso8601: "2023-03-04T09:46:14Z"
2280422805
end_date_timestamp: 1677923174
22806+
CX Score rating: 4
22807+
CX Score explanation: The conversation was resolved quickly and the customer
22808+
expressed satisfaction with the outcome.
2280522809
custom_object_instance:
2280622810
title: Custom Object Instance
2280722811
type: object

descriptions/2.13/api.intercom.io.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16920,7 +16920,8 @@ components:
1692016920
type: object
1692116921
description: An object containing the different custom attributes associated
1692216922
to the conversation as key-value pairs. For relationship attributes the value
16923-
will be a list of custom object instance models.
16923+
will be a list of custom object instance models. System-defined attributes
16924+
such as "CX Score rating" and "CX Score explanation" may also be included.
1692416925
additionalProperties:
1692516926
anyOf:
1692616927
- type: string

descriptions/2.14/api.intercom.io.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18580,7 +18580,8 @@ components:
1858018580
type: object
1858118581
description: An object containing the different custom attributes associated
1858218582
to the conversation as key-value pairs. For relationship attributes the value
18583-
will be a list of custom object instance models.
18583+
will be a list of custom object instance models. System-defined attributes
18584+
such as "CX Score rating" and "CX Score explanation" may also be included.
1858418585
additionalProperties:
1858518586
anyOf:
1858618587
- type: string
@@ -18593,6 +18594,9 @@ components:
1859318594
team_mates: 9
1859418595
start_date_iso8601: "2023-03-04T09:46:14Z"
1859518596
end_date_timestamp: 1677923174
18597+
CX Score rating: 4
18598+
CX Score explanation: The conversation was resolved quickly and the customer
18599+
expressed satisfaction with the outcome.
1859618600
custom_object_instance:
1859718601
title: Custom Object Instance
1859818602
type: object

descriptions/2.15/api.intercom.io.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19307,7 +19307,8 @@ components:
1930719307
type: object
1930819308
description: An object containing the different custom attributes associated
1930919309
to the conversation as key-value pairs. For relationship attributes the value
19310-
will be a list of custom object instance models.
19310+
will be a list of custom object instance models. System-defined attributes
19311+
such as "CX Score rating" and "CX Score explanation" may also be included.
1931119312
additionalProperties:
1931219313
anyOf:
1931319314
- type: string
@@ -19320,6 +19321,9 @@ components:
1932019321
team_mates: 9
1932119322
start_date_iso8601: "2023-03-04T09:46:14Z"
1932219323
end_date_timestamp: 1677923174
19324+
CX Score rating: 4
19325+
CX Score explanation: The conversation was resolved quickly and the customer
19326+
expressed satisfaction with the outcome.
1932319327
custom_object_instance:
1932419328
title: Custom Object Instance
1932519329
type: object

0 commit comments

Comments
 (0)