Skip to content

Commit bfaa0d8

Browse files
toquisclaude
andauthored
Document notes, reviewer and review_status on Preview scorecard entries (#673)
* Document notes, reviewer and review_status on Preview scorecard entries Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * Add an example to the scorecard notes list property Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
1 parent b862a25 commit bfaa0d8

1 file changed

Lines changed: 157 additions & 0 deletions

File tree

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

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12501,6 +12501,21 @@ paths:
1250112501
reviewed_teammate:
1250212502
type: admin
1250312503
admin_id: '991267715'
12504+
reviewer:
12505+
type: admin
12506+
admin_id: '884120017'
12507+
review_status: submitted
12508+
notes:
12509+
type: note.list
12510+
notes:
12511+
- type: note
12512+
id: '9001'
12513+
created_at: 1734537900
12514+
updated_at: 1734537900
12515+
author:
12516+
type: admin
12517+
admin_id: '884120017'
12518+
body: Great empathy in the second reply.
1250412519
evaluators:
1250512520
- evaluator_id: '54321'
1250612521
result:
@@ -13201,6 +13216,21 @@ paths:
1320113216
reviewed_teammate:
1320213217
type: admin
1320313218
admin_id: '991267715'
13219+
reviewer:
13220+
type: admin
13221+
admin_id: '884120017'
13222+
review_status: submitted
13223+
notes:
13224+
type: note.list
13225+
notes:
13226+
- type: note
13227+
id: '9001'
13228+
created_at: 1734537900
13229+
updated_at: 1734537900
13230+
author:
13231+
type: admin
13232+
admin_id: '884120017'
13233+
body: Great empathy in the second reply.
1320413234
evaluators:
1320513235
- evaluator_id: '54321'
1320613236
result:
@@ -13931,6 +13961,21 @@ paths:
1393113961
reviewed_teammate:
1393213962
type: admin
1393313963
admin_id: '991267715'
13964+
reviewer:
13965+
type: admin
13966+
admin_id: '884120017'
13967+
review_status: submitted
13968+
notes:
13969+
type: note.list
13970+
notes:
13971+
- type: note
13972+
id: '9001'
13973+
created_at: 1734537900
13974+
updated_at: 1734537900
13975+
author:
13976+
type: admin
13977+
admin_id: '884120017'
13978+
body: Great empathy in the second reply.
1393413979
evaluators:
1393513980
- evaluator_id: '54321'
1393613981
result:
@@ -33450,11 +33495,123 @@ components:
3345033495
example: 1719493065
3345133496
reviewed_teammate:
3345233497
"$ref": "#/components/schemas/conversation_scorecard_reviewed_teammate"
33498+
reviewer:
33499+
"$ref": "#/components/schemas/conversation_scorecard_reviewer"
33500+
review_status:
33501+
type: string
33502+
nullable: true
33503+
enum:
33504+
- unreviewed
33505+
- submitted
33506+
- passed_review
33507+
- needs_fix
33508+
- wont_fix
33509+
- fix_complete
33510+
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.
33511+
example: submitted
33512+
notes:
33513+
"$ref": "#/components/schemas/conversation_scorecard_notes"
3345333514
evaluators:
3345433515
type: array
3345533516
description: Per-evaluator results within this scorecard.
3345633517
items:
3345733518
"$ref": "#/components/schemas/conversation_scorecard_evaluator"
33519+
conversation_scorecard_reviewer:
33520+
title: Reviewer
33521+
type: object
33522+
nullable: true
33523+
x-tags:
33524+
- Conversations
33525+
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.
33526+
properties:
33527+
type:
33528+
type: string
33529+
enum:
33530+
- ai
33531+
- admin
33532+
description: The kind of reviewer. `ai` if Fin auto-reviewed the scorecard; `admin` if a teammate reviewed it.
33533+
example: admin
33534+
admin_id:
33535+
type: string
33536+
nullable: true
33537+
description: The id of the admin who reviewed the scorecard. Present only when `type` is `admin`.
33538+
example: '884120017'
33539+
conversation_scorecard_notes:
33540+
title: Scorecard Notes
33541+
type: object
33542+
x-tags:
33543+
- Conversations
33544+
description: The notes teammates left on the QA review linked to this scorecard entry. The list is empty when the scorecard has no linked review.
33545+
properties:
33546+
type:
33547+
type: string
33548+
description: String representing the object's type. Always has the value `note.list`.
33549+
example: note.list
33550+
notes:
33551+
type: array
33552+
description: The notes on the linked review, oldest first.
33553+
example:
33554+
- type: note
33555+
id: '9001'
33556+
created_at: 1734537900
33557+
updated_at: 1734537900
33558+
author:
33559+
type: admin
33560+
admin_id: '884120017'
33561+
body: Great empathy in the second reply.
33562+
items:
33563+
"$ref": "#/components/schemas/conversation_scorecard_note"
33564+
conversation_scorecard_note:
33565+
title: Scorecard Note
33566+
type: object
33567+
x-tags:
33568+
- Conversations
33569+
description: A note a teammate left on the QA review of this scorecard.
33570+
properties:
33571+
type:
33572+
type: string
33573+
description: String representing the object's type. Always has the value `note`.
33574+
example: note
33575+
id:
33576+
type: string
33577+
description: The id of the note.
33578+
example: '9001'
33579+
created_at:
33580+
type: integer
33581+
format: date-time
33582+
description: The time the note was created.
33583+
example: 1734537900
33584+
updated_at:
33585+
type: integer
33586+
format: date-time
33587+
description: The time the note was last edited. Equal to `created_at` when the note has never been edited.
33588+
example: 1734537900
33589+
author:
33590+
"$ref": "#/components/schemas/conversation_scorecard_note_author"
33591+
body:
33592+
type: string
33593+
description: The text of the note exactly as the teammate entered it. Plain text; it is not rendered as HTML.
33594+
example: Great empathy in the second reply.
33595+
conversation_scorecard_note_author:
33596+
title: Note Author
33597+
type: object
33598+
nullable: true
33599+
x-tags:
33600+
- Conversations
33601+
description: Who wrote the note. Null when the teammate who wrote it has since been deleted.
33602+
properties:
33603+
type:
33604+
type: string
33605+
enum:
33606+
- ai
33607+
- admin
33608+
description: The kind of author. `admin` when a teammate wrote the note; `ai` when Fin did.
33609+
example: admin
33610+
admin_id:
33611+
type: string
33612+
nullable: true
33613+
description: The id of the admin who wrote the note. Present only when `type` is `admin`.
33614+
example: '884120017'
3345833615
conversation_scorecard_reviewed_teammate:
3345933616
title: Reviewed Teammate
3346033617
type: object

0 commit comments

Comments
 (0)