Skip to content

Add fin guidance applied schema in event_details in the conversations API #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+40 −0
Open

Add fin guidance applied schema in event_details in the conversations API #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5150e2
Add fin guidance applied schema in event_details in the conversations…
toquis Aug 6, 2025
ee99973
update schema in 2.13 version
toquis Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18634,6 +18634,25 @@ components:
type: string
description: Result of the workflow event
example: Finsihed waiting
fin_guidance_applied:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just realised as well, you're going to want to make these changes in the 2.13 version as well, 0 here refers to unstable but since your new change isn't versioned we'll need to update the docs for whichever version we're already documenting these event details

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, thanks for explaining the API versions. I have updated the PR to include the changes in that version.

title: Part type - fin_guidance_applied
type: object
description: Contains details about the guidance that was applied for conversation part type <code>fin_guidance_applied</code>.
properties:
guidelines:
type: array
description: Array of guidance objects that were applied
items:
type: object
properties:
id:
type: string
description: The unique identifier of the guidance
example: "1"
title:
type: string
description: The title of the guidance
example: "Be helpful"
event_details:
title: Event details of Workflow & actions
type: object
Expand All @@ -18643,6 +18662,7 @@ components:
- "$ref": "#/components/schemas/custom_action_started"
- "$ref": "#/components/schemas/custom_action_finished"
- "$ref": "#/components/schemas/operator_workflow_event"
- "$ref": "#/components/schemas/fin_guidance_applied"
error:
type: object
title: Error
Expand Down
20 changes: 20 additions & 0 deletions descriptions/2.13/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17475,6 +17475,25 @@ components:
type: string
description: Result of the workflow event
example: Finsihed waiting
fin_guidance_applied:
title: Part type - fin_guidance_applied
type: object
description: Contains details about the guidance that was applied for conversation part type <code>fin_guidance_applied</code>.
properties:
guidelines:
type: array
description: Array of guidance objects that were applied
items:
type: object
properties:
id:
type: string
description: The unique identifier of the guidance
example: "1"
title:
type: string
description: The title of the guidance
example: "Be helpful"
event_details:
title: Event details of Workflow & actions
type: object
Expand All @@ -17484,6 +17503,7 @@ components:
- "$ref": "#/components/schemas/custom_action_started"
- "$ref": "#/components/schemas/custom_action_finished"
- "$ref": "#/components/schemas/operator_workflow_event"
- "$ref": "#/components/schemas/fin_guidance_applied"
error:
type: object
title: Error
Expand Down