Skip to content

docs(api): daily audit 2026-10-16 — RUM issue resolve mode, chat-bound Automation rules #1061

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

Closed
flashduty wants to merge 1 commit into from
Closed

docs(api): daily audit 2026-10-16 — RUM issue resolve mode, chat-bound Automation rules #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
131 changes: 128 additions & 3 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3215,6 +3215,55 @@
],
"type": "object"
},
"AutomationExecutionLocation": {
"description": "Read-only description of where the rule runs, shown in the console.",
"properties": {
"chat_name": {
"description": "Chat name of the pinned chat. Set only for an IM destination.",
"type": "string"
},
"conversation_mode": {
"description": "Conversation mode of the pinned chat. Set only for an IM destination.",
"type": "string"
},
"description": {
"description": "Human-readable destination label: the chat name, the platform and mode, or `Web console`.",
"type": "string"
},
"place": {
"description": "Execution place: `im` or `web_console`.",
"enum": [
"im",
"web_console"
],
"type": "string"
},
"platform": {
"description": "IM platform of the pinned chat. Set only for an IM destination.",
"type": "string"
},
"run_scope": {
"description": "Run scope of the pinned destination.",
"enum": [
"person",
"team"
],
"type": "string"
},
"team_id": {
"description": "Team ID of the pinned scope; 0 for a personal scope.",
"format": "int64",
"type": "integer"
}
},
"required": [
"place",
"run_scope",
"team_id",
"description"
],
"type": "object"
},
"AutomationRuleCreateRequest": {
"description": "Create an Automation rule.",
"properties": {
Expand Down Expand Up @@ -3288,10 +3337,24 @@
]
},
"team_id": {
"description": "Scope team ID. 0 or omitted means a personal rule; >0 means a team in the account. Can be reassigned later via update (converting a team rule to personal is owner-only; moving into a team requires the caller to belong to it).",
"description": "Scope team ID. Omitted means inherit the scope of the conversation the rule is created from, when the request carries an IM conversation; otherwise the rule is personal. An explicit `0` asks for a personal rule and `>0` targets that team in the account. Can be reassigned later via update (converting a team rule to personal is owner-only; moving into a team requires the caller to belong to it).",
"format": "int64",
"minimum": 0,
"type": "integer"
"type": [
"integer",
"null"
]
},
"run_in": {
"description": "Where the rule runs. `current-chat` binds it to the live IM conversation it is created from, so its runs stay in that chat; `web` runs it in a hidden console session. Defaults to `current-chat` for a request carrying an IM conversation and to `web` otherwise; `current-chat` is rejected without a live IM conversation.",
"enum": [
"current-chat",
"web"
],
"type": [
"string",
"null"
]
},
"timezone": {
"description": "IANA timezone `cron_expr` is evaluated in, e.g. `Asia/Shanghai`. Must be a timezone name loadable by the server; an invalid value is rejected. Defaults to the caller's member timezone, then the account timezone, then the server default (Asia/Shanghai) when omitted.",
Expand Down Expand Up @@ -3355,6 +3418,17 @@
],
"type": "string"
},
"execution_location": {
"$ref": "#/components/schemas/AutomationExecutionLocation"
},
"execution_place": {
"description": "Where this rule's ordinary triggers run: `web_console` (a hidden console session) or `im` (the IM chat the rule is pinned to). A war-room trigger still runs in that event's war room. The pinned chat and scope cannot be changed after create.",
"enum": [
"im",
"web_console"
],
"type": "string"
},
"http_post_token": {
"description": "HTTP POST trigger token. Returned only on create or token rotation; save it immediately.",
"type": "string"
Expand Down Expand Up @@ -3472,7 +3546,8 @@
"created_at",
"updated_at",
"schedule_next_fire_at_ms",
"oncall_incident_trigger_enabled"
"oncall_incident_trigger_enabled",
"execution_place"
],
"type": "object"
},
Expand Down Expand Up @@ -21172,6 +21247,15 @@
},
"type": "object"
},
"resolve_mode": {
"description": "Reopen policy of this issue. `any` reopens it on any recurrence; `version` reopens it only when the error recurs in an application version the issue has not seen. Issues created before this field shipped carry an empty value, which behaves like `version`.",
"enum": [
"",
"any",
"version"
],
"type": "string"
},
"resolved_at": {
"description": "Time the issue was marked resolved, Unix timestamp in milliseconds; 0 while unresolved.",
"format": "int64",
Expand Down Expand Up @@ -21407,6 +21491,14 @@
],
"type": "string"
},
"resolve_mode": {
"description": "Reopen policy set together with `status: resolved`. `any` reopens the issue on any recurring error; `version` reopens it only when the error recurs in an application version the issue has not seen. Applied only while `status` is `resolved`; omitted there means the issue is resolved with `any`.",
"enum": [
"any",
"version"
],
"type": "string"
},
"suspected_cause": {
"description": "New suspected cause; setting it marks the cause source as `user`, overriding the automatic classification. One of:\n\n| Value | Meaning |\n|---|---|\n| `api.failed_request` | API request failure |\n| `network.error` | Network connectivity error |\n| `code.exception` | Code exception |\n| `code.invalid_object_access` | Invalid object access |\n| `code.invalid_argument` | Invalid argument |\n| `unknown` | Unknown cause |",
"enum": [
Expand Down Expand Up @@ -52849,6 +52941,7 @@
"timestamp": 1775961839090,
"version": "1.0.0"
},
"resolve_mode": "version",
"resolved_at": 0,
"resolved_by": 0,
"service": "fd-console",
Expand Down Expand Up @@ -52969,6 +53062,7 @@
"timestamp": 1775961839090,
"version": "1.0.0"
},
"resolve_mode": "version",
"resolved_at": 0,
"resolved_by": 0,
"service": "fd-console",
Expand Down Expand Up @@ -53007,6 +53101,7 @@
"timestamp": 1775189527762,
"version": "1.0.0"
},
"resolve_mode": "version",
"resolved_at": 0,
"resolved_by": 0,
"service": "fd-console",
Expand Down Expand Up @@ -53918,6 +54013,7 @@
"application/json": {
"example": {
"issue_id": "NHEacQHi2DhXqobr9qPQz9",
"resolve_mode": "version",
"status": "resolved"
},
"schema": {
Expand Down Expand Up @@ -55856,6 +55952,7 @@
],
"oncall_incident_trigger_enabled": true,
"prompt": "Summarize last week's alert noise and escalation load.",
"run_in": "web",
"schedule_trigger_enabled": true,
"team_id": 123,
"timezone": "Asia/Shanghai"
Expand All @@ -55880,6 +55977,13 @@
"enabled": true,
"environment_id": "",
"environment_kind": "",
"execution_location": {
"place": "web_console",
"run_scope": "team",
"team_id": 123,
"description": "Web console"
},
"execution_place": "web_console",
"http_post_token": "sat_yQ9p8V7n6M5k4J3h2G1f0E9d8C7b6A5z4Y3x2W1v0U",
"http_post_trigger_enabled": true,
"http_post_trigger_id": "atrig_2bLq4xT8mP1sWd9cN3rF6y",
Expand Down Expand Up @@ -56069,6 +56173,13 @@
"enabled": true,
"environment_id": "",
"environment_kind": "",
"execution_location": {
"place": "web_console",
"run_scope": "team",
"team_id": 123,
"description": "Web console"
},
"execution_place": "web_console",
"http_post_trigger_enabled": true,
"http_post_trigger_id": "atrig_2bLq4xT8mP1sWd9cN3rF6y",
"http_post_trigger_url": "/safari/automation/triggers/atrig_2bLq4xT8mP1sWd9cN3rF6y/fire",
Expand Down Expand Up @@ -56181,6 +56292,13 @@
"enabled": true,
"environment_id": "",
"environment_kind": "",
"execution_location": {
"place": "web_console",
"run_scope": "team",
"team_id": 123,
"description": "Web console"
},
"execution_place": "web_console",
"http_post_trigger_enabled": true,
"http_post_trigger_id": "atrig_2bLq4xT8mP1sWd9cN3rF6y",
"http_post_trigger_url": "/safari/automation/triggers/atrig_2bLq4xT8mP1sWd9cN3rF6y/fire",
Expand Down Expand Up @@ -56403,6 +56521,13 @@
"enabled": true,
"environment_id": "",
"environment_kind": "",
"execution_location": {
"place": "web_console",
"run_scope": "team",
"team_id": 123,
"description": "Web console"
},
"execution_place": "web_console",
"http_post_token": "sat_yQ9p8V7n6M5k4J3h2G1f0E9d8C7b6A5z4Y3x2W1v0U",
"http_post_trigger_enabled": true,
"http_post_trigger_id": "atrig_2bLq4xT8mP1sWd9cN3rF6y",
Expand Down
Loading
Loading