Skip to content

Commit e98b779

Browse files
Add conversation part event details for SolidRoad feature requests (#316)
* Add conversation part event details for SolidRoad feature requests - Add 9 new conversation part schemas with event_details: - conversation_tags_updated (tags added/removed) - snoozed (snooze timing with custom_until_time) - priority_changed (current/previous priority states) - conversation_sla_applied_by_rule (SLA with definition) - conversation_sla_applied_by_workflow (SLA with definition) - conversation_sla_target_missed (SLA breach with states) - conversation_sla_paused (SLA pause status) - conversation_sla_unpaused (SLA unpause) - conversation_sla_removed (SLA removal) - Add conversation_attribute_updated_by_user schema with previous value tracking - Update existing attribute update schemas with previous field: - conversation_attribute_updated_by_admin - conversation_attribute_updated_by_workflow Related to intercom/intercom#428476, #430980, #430942 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * Remove user from response ( it was invalid ) * Revert changes to conversation_attribute_updated_by_workflow schema Remove the incorrectly added previous field from conversation_attribute_updated_by_workflow - this feature was never implemented (PRs #432721 and #433432 were closed without merging). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Clean description --------- Co-authored-by: Claude <[email protected]>
1 parent 0fc8273 commit e98b779

File tree

1 file changed

+246
-1
lines changed

1 file changed

+246
-1
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 246 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20155,8 +20155,37 @@ components:
2015520155
properties:
2015620156
name:
2015720157
type: string
20158-
description: Value of the CDA updated
20158+
description: Current value of the CDA updated
2015920159
example: PROJ-007
20160+
previous:
20161+
type: string
20162+
nullable: true
20163+
description: Previous value of the CDA
20164+
example: PROJ-006
20165+
conversation_attribute_updated_by_user:
20166+
title: Part type - conversation_attribute_updated_by_user
20167+
type: object
20168+
description: Contains details about Custom Data Attributes (CDAs) that were modified by a user for conversation part type <code>conversation_attribute_updated_by_user</code>.
20169+
properties:
20170+
attribute:
20171+
type: object
20172+
properties:
20173+
name:
20174+
type: string
20175+
description: Name of the CDA updated
20176+
example: Priority
20177+
value:
20178+
type: object
20179+
properties:
20180+
name:
20181+
type: string
20182+
description: Current value of the CDA updated
20183+
example: High
20184+
previous:
20185+
type: string
20186+
nullable: true
20187+
description: Previous value of the CDA (null for older events)
20188+
example: Medium
2016020189
custom_action_started:
2016120190
title: Part type - custom_action_started
2016220191
type: object
@@ -20281,15 +20310,231 @@ components:
2028120310
type: string
2028220311
description: Result of the workflow event
2028320312
example: Finsihed waiting
20313+
conversation_tags_updated:
20314+
title: Part type - conversation_tags_updated
20315+
type: object
20316+
description: Contains details about tags that were added or removed from a conversation for conversation part type <code>conversation_tags_updated</code>.
20317+
properties:
20318+
tags_added:
20319+
type: array
20320+
items:
20321+
type: string
20322+
description: Array of tag names that were added
20323+
example: ["feature-shopify-multi-store", "second-tag"]
20324+
tags_removed:
20325+
type: array
20326+
items:
20327+
type: string
20328+
description: Array of tag names that were removed
20329+
example: ["feature-embercom-app-serializer-limit-external-plans"]
20330+
snoozed:
20331+
title: Part type - snoozed
20332+
type: object
20333+
description: Contains details about conversation snooze timing for conversation part type <code>snoozed</code>.
20334+
properties:
20335+
until:
20336+
type: string
20337+
description: Human-readable description of snooze duration
20338+
example: "until tomorrow"
20339+
custom_until_time:
20340+
type: string
20341+
format: date-time
20342+
nullable: true
20343+
description: ISO timestamp for custom snooze times (null for general snoozes)
20344+
example: "2025-09-03T18:44:20.146Z"
20345+
priority_changed:
20346+
title: Part type - priority_changed
20347+
type: object
20348+
description: Contains details about priority changes for conversation part type <code>priority_changed</code>.
20349+
properties:
20350+
current_priority:
20351+
type: string
20352+
enum: ["priority", "not_priority"]
20353+
description: Current priority state
20354+
example: "priority"
20355+
previous_priority:
20356+
type: string
20357+
enum: ["priority", "not_priority"]
20358+
description: Previous priority state
20359+
example: "not_priority"
20360+
conversation_sla_applied_by_rule:
20361+
title: Part type - conversation_sla_applied_by_rule
20362+
type: object
20363+
description: Contains details about SLA applied by modern Operator workflows for conversation part type <code>conversation_sla_applied_by_rule</code>.
20364+
properties:
20365+
sla_name:
20366+
type: string
20367+
description: Name of the SLA that was applied
20368+
example: "Premium SLA"
20369+
sla_definition:
20370+
type: object
20371+
description: Target times configured for the SLA (in seconds)
20372+
properties:
20373+
first_reply_time:
20374+
type: integer
20375+
nullable: true
20376+
description: First response time target in seconds
20377+
example: 300
20378+
next_reply_time:
20379+
type: integer
20380+
nullable: true
20381+
description: Next reply time target in seconds
20382+
example: 600
20383+
resolution_time:
20384+
type: integer
20385+
nullable: true
20386+
description: Resolution time target in seconds
20387+
example: 3600
20388+
time_to_close:
20389+
type: integer
20390+
nullable: true
20391+
description: Time to close target in seconds
20392+
example: 7200
20393+
conversation_sla_applied_by_workflow:
20394+
title: Part type - conversation_sla_applied_by_workflow
20395+
type: object
20396+
description: Contains details about SLA applied by legacy Inbox Rules for conversation part type <code>conversation_sla_applied_by_workflow</code>.
20397+
properties:
20398+
sla_name:
20399+
type: string
20400+
description: Name of the SLA that was applied
20401+
example: "Standard SLA"
20402+
sla_definition:
20403+
type: object
20404+
description: Target times configured for the SLA (in seconds)
20405+
properties:
20406+
first_reply_time:
20407+
type: integer
20408+
nullable: true
20409+
description: First response time target in seconds
20410+
example: 300
20411+
next_reply_time:
20412+
type: integer
20413+
nullable: true
20414+
description: Next reply time target in seconds
20415+
example: 600
20416+
resolution_time:
20417+
type: integer
20418+
nullable: true
20419+
description: Resolution time target in seconds
20420+
example: 3600
20421+
time_to_close:
20422+
type: integer
20423+
nullable: true
20424+
description: Time to close target in seconds
20425+
example: 7200
20426+
conversation_sla_target_missed:
20427+
title: Part type - conversation_sla_target_missed
20428+
type: object
20429+
description: Contains complete status of all SLA targets when a breach occurs for conversation part type <code>conversation_sla_target_missed</code>.
20430+
properties:
20431+
sla_name:
20432+
type: string
20433+
description: Name of the SLA
20434+
example: "HandleConversation"
20435+
sla_target_type:
20436+
type: string
20437+
enum: ["first_reply_time", "next_reply_time", "resolution_time", "time_to_close"]
20438+
description: Which specific target was missed
20439+
example: "first_reply_time"
20440+
current_sla_status:
20441+
type: string
20442+
enum: ["hit", "missed", "active", "paused", "canceled"]
20443+
description: Overall SLA status
20444+
example: "missed"
20445+
sla_states:
20446+
type: object
20447+
description: Status of all SLA targets at the time of breach
20448+
additionalProperties:
20449+
type: object
20450+
properties:
20451+
status:
20452+
type: string
20453+
enum: ["hit", "missed", "active", "paused"]
20454+
description: Status of this specific target
20455+
seconds_remaining:
20456+
type: integer
20457+
nullable: true
20458+
description: Time remaining for active/paused targets (null for hit/missed)
20459+
example:
20460+
first_reply_time:
20461+
status: "missed"
20462+
seconds_remaining: null
20463+
time_to_close:
20464+
status: "active"
20465+
seconds_remaining: 210
20466+
conversation_sla_paused:
20467+
title: Part type - conversation_sla_paused
20468+
type: object
20469+
description: Contains SLA status at the moment of pausing for conversation part type <code>conversation_sla_paused</code>.
20470+
properties:
20471+
sla_name:
20472+
type: string
20473+
description: Name of the SLA being paused
20474+
example: "Premium SLA"
20475+
current_sla_status:
20476+
type: string
20477+
enum: ["active", "hit", "missed", "canceled"]
20478+
description: Overall SLA status at pause time
20479+
example: "active"
20480+
sla_states:
20481+
type: object
20482+
description: Status of all SLA targets at pause time
20483+
additionalProperties:
20484+
type: object
20485+
properties:
20486+
status:
20487+
type: string
20488+
enum: ["paused"]
20489+
description: Status of this specific target (always paused)
20490+
seconds_remaining:
20491+
type: integer
20492+
nullable: true
20493+
description: Time remaining when paused
20494+
example:
20495+
first_reply_time:
20496+
status: "paused"
20497+
seconds_remaining: 3600
20498+
time_to_close:
20499+
status: "paused"
20500+
seconds_remaining: 7200
20501+
conversation_sla_unpaused:
20502+
title: Part type - conversation_sla_unpaused
20503+
type: object
20504+
description: Contains basic SLA information when unpaused for conversation part type <code>conversation_sla_unpaused</code>.
20505+
properties:
20506+
sla_name:
20507+
type: string
20508+
description: Name of the SLA being unpaused
20509+
example: "Premium SLA"
20510+
conversation_sla_removed:
20511+
title: Part type - conversation_sla_removed
20512+
type: object
20513+
description: Contains basic SLA information when removed for conversation part type <code>conversation_sla_removed</code>.
20514+
properties:
20515+
sla_name:
20516+
type: string
20517+
description: Name of the SLA that was removed
20518+
example: "Standard SLA"
2028420519
event_details:
2028520520
title: Event details of Workflow & actions
2028620521
type: object
2028720522
anyOf:
2028820523
- "$ref": "#/components/schemas/conversation_attribute_updated_by_workflow"
2028920524
- "$ref": "#/components/schemas/conversation_attribute_updated_by_admin"
20525+
- "$ref": "#/components/schemas/conversation_attribute_updated_by_user"
2029020526
- "$ref": "#/components/schemas/custom_action_started"
2029120527
- "$ref": "#/components/schemas/custom_action_finished"
2029220528
- "$ref": "#/components/schemas/operator_workflow_event"
20529+
- "$ref": "#/components/schemas/conversation_tags_updated"
20530+
- "$ref": "#/components/schemas/snoozed"
20531+
- "$ref": "#/components/schemas/priority_changed"
20532+
- "$ref": "#/components/schemas/conversation_sla_applied_by_rule"
20533+
- "$ref": "#/components/schemas/conversation_sla_applied_by_workflow"
20534+
- "$ref": "#/components/schemas/conversation_sla_target_missed"
20535+
- "$ref": "#/components/schemas/conversation_sla_paused"
20536+
- "$ref": "#/components/schemas/conversation_sla_unpaused"
20537+
- "$ref": "#/components/schemas/conversation_sla_removed"
2029320538
email_setting:
2029420539
type: object
2029520540
title: Email Setting

0 commit comments

Comments
 (0)