Skip to content

Commit b57a386

Browse files
danielep-finclaude
andauthored
Document submitted_by and revised_by on Preview conversation scorecards (#706)
Adds both fields to scorecard entries with their schemas and examples, and describes reviewer as who the review is assigned to. Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent 0ad79bb commit b57a386

1 file changed

Lines changed: 59 additions & 3 deletions

File tree

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12521,6 +12521,10 @@ paths:
1252112521
type: admin
1252212522
admin_id: '884120017'
1252312523
review_status: submitted
12524+
submitted_by:
12525+
type: admin
12526+
admin_id: '884120017'
12527+
revised_by: null
1252412528
notes:
1252512529
- id: '9001'
1252612530
created_at: 1734537900
@@ -13261,6 +13265,10 @@ paths:
1326113265
type: admin
1326213266
admin_id: '884120017'
1326313267
review_status: submitted
13268+
submitted_by:
13269+
type: admin
13270+
admin_id: '884120017'
13271+
revised_by: null
1326413272
notes:
1326513273
- id: '9001'
1326613274
created_at: 1734537900
@@ -14007,6 +14015,10 @@ paths:
1400714015
type: admin
1400814016
admin_id: '884120017'
1400914017
review_status: submitted
14018+
submitted_by:
14019+
type: admin
14020+
admin_id: '884120017'
14021+
revised_by: null
1401014022
notes:
1401114023
- id: '9001'
1401214024
created_at: 1734537900
@@ -33840,6 +33852,10 @@ components:
3384033852
- fix_complete
3384133853
description: The status of the review of this scorecard, as shown in the QA reviews list in Intercom. `unreviewed` while the review is waiting for a reviewer's verdict; `submitted` once the review has been submitted; `passed_review`, `needs_fix`, `wont_fix` or `fix_complete` when a teammate set a specific outcome. Null when no review exists for this scorecard.
3384233854
example: submitted
33855+
submitted_by:
33856+
"$ref": "#/components/schemas/conversation_scorecard_submitted_by"
33857+
revised_by:
33858+
"$ref": "#/components/schemas/conversation_scorecard_revised_by"
3384333859
notes:
3384433860
type: array
3384533861
description: The notes teammates left on the QA review linked to this scorecard entry. Empty when the scorecard has no linked review.
@@ -33864,19 +33880,59 @@ components:
3386433880
nullable: true
3386533881
x-tags:
3386633882
- Conversations
33867-
description: Who reviewed this scorecard. `ai` when Fin auto-reviewed it; `admin` when a teammate did. Null when no review exists for this scorecard or no reviewer has been assigned yet.
33883+
description: Who the review of this scorecard is assigned to. `ai` when it is assigned to Fin; `admin` when it is assigned to a teammate. Null when no review exists for this scorecard or the review is unassigned.
33884+
properties:
33885+
type:
33886+
type: string
33887+
enum:
33888+
- ai
33889+
- admin
33890+
description: The kind of reviewer. `ai` if the review is assigned to Fin; `admin` if it is assigned to a teammate.
33891+
example: admin
33892+
admin_id:
33893+
type: string
33894+
nullable: true
33895+
description: The id of the admin the review is assigned to. Present only when `type` is `admin`.
33896+
example: '884120017'
33897+
conversation_scorecard_submitted_by:
33898+
title: Submitted By
33899+
type: object
33900+
nullable: true
33901+
x-tags:
33902+
- Conversations
33903+
description: Who last submitted the review of this scorecard, which can differ from the `reviewer` it is assigned to. `ai` when Fin submitted it; `admin` when a teammate did. Null while the review is unreviewed or when no review exists for this scorecard.
33904+
properties:
33905+
type:
33906+
type: string
33907+
enum:
33908+
- ai
33909+
- admin
33910+
description: The kind of submitter. `ai` if Fin submitted the review; `admin` if a teammate did.
33911+
example: admin
33912+
admin_id:
33913+
type: string
33914+
nullable: true
33915+
description: The id of the admin who submitted the review. Present only when `type` is `admin`.
33916+
example: '884120017'
33917+
conversation_scorecard_revised_by:
33918+
title: Revised By
33919+
type: object
33920+
nullable: true
33921+
x-tags:
33922+
- Conversations
33923+
description: Who last changed the review of this scorecard after it was submitted. `ai` when Fin made the change; `admin` when a teammate did. Null while the review is unreviewed, when it has not been changed since it was submitted, or when no review exists for this scorecard.
3386833924
properties:
3386933925
type:
3387033926
type: string
3387133927
enum:
3387233928
- ai
3387333929
- admin
33874-
description: The kind of reviewer. `ai` if Fin auto-reviewed the scorecard; `admin` if a teammate reviewed it.
33930+
description: The kind of reviser. `ai` if Fin changed the review; `admin` if a teammate did.
3387533931
example: admin
3387633932
admin_id:
3387733933
type: string
3387833934
nullable: true
33879-
description: The id of the admin who reviewed the scorecard. Present only when `type` is `admin`.
33935+
description: The id of the admin who last changed the review. Present only when `type` is `admin`.
3388033936
example: '884120017'
3388133937
conversation_scorecard_note:
3388233938
title: Scorecard Note

0 commit comments

Comments
 (0)