Skip to content

Show the occupancy events in the activity log examples - #727

Draft
markdennis22 wants to merge 2 commits into
mainfrom
align/activity-log-examples
Draft

markdennis22 wants to merge 2 commits into
mainfrom
align/activity-log-examples

Conversation

@markdennis22

Copy link
Copy Markdown
Contributor

Why?

The activity log reference documents the admin_occupancy_state_change and admin_occupancy_setting_change event types, but its response examples show neither. The before and after values in changes also have no example. The 2.13 alignment PR fixed this for 2.13. This PR makes the same fix in the newer versions, and a companion PR makes it on developers.intercom.com, so the two references stay identical.

How?

Adds one admin_occupancy_state_change entry and one admin_occupancy_setting_change entry to the GET /admins/activity_logs response example. In versions that have POST /admins/activity_logs/search, they go in its response example too. The system records the state change, so its performed_by.ip is unknown. The before and after values in activity_log_metadata.changes each get an example, and their descriptions say they take the setting's own type. They have no type, because the value can be an integer, a boolean, a string or a list. Affects 2.14, 2.15, 2.16, 2.17 and Preview. The wording is the same as in 2.13.

Notes for reviewers
  • There are two commits. The first covers 2.16, 2.17 and Preview. The second covers 2.14 and 2.15, because developers.intercom.com gets the occupancy fields for those versions only when its open 2.14 and 2.15 alignment PRs merge.
  • The new entries use the same admin id and created_at as the entries already in each example, as 2.13 does.
  • Fern check: 0 errors and the same 313 warnings as main. Fern reads 2.14 and Preview, and this PR changes both.

Generated with Claude Code

markdennis22 and others added 2 commits October 14, 2026 15:03
In 2.16, 2.17 and Preview, add an admin_occupancy_state_change and an
admin_occupancy_setting_change entry to the GET /admins/activity_logs
and POST /admins/activity_logs/search response examples, so they show
previous_state, new_state, threshold_minutes, last_activity_at, auto,
setting_type and changes. The state change is recorded by the system,
so its performed_by ip is `unknown`.

The before and after values in activity_log_metadata.changes get an
example each, and their descriptions say they take the setting's own
type. They keep no `type`, because the value can be an integer, a
boolean, a string or a list depending on the setting.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
In 2.14 and 2.15, add an admin_occupancy_state_change and an
admin_occupancy_setting_change entry to the GET /admins/activity_logs
response example, so it shows previous_state, new_state,
threshold_minutes, last_activity_at, auto, setting_type and changes.
The state change is recorded by the system, so its performed_by ip is
`unknown`.

The before and after values in activity_log_metadata.changes get an
example each, and their descriptions say they take the setting's own
type. They keep no `type`, because the value can be an integer, a
boolean, a string or a list depending on the setting.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant