Skip to content

Conversation

@Rosie-Kennelly-1
Copy link
Contributor

@Rosie-Kennelly-1 Rosie-Kennelly-1 commented Nov 24, 2025

Summary

Adds OpenAPI documentation for the automatic_away_mode_setting_change activity type to API version 2.14.

This activity type tracks when automatic away mode settings are changed by admins, allowing developers to monitor automatic away mode configuration changes through the Admin Activity Logs API.

Changes

Activity Type Enum

Adds automatic_away_mode_setting_change to the activity_type enum in the activity_log schema (in alphabetical order).

Metadata Fields

Adds generic before and after object fields to activity_log_metadata schema to support various activity types that track setting changes. These fields store the state before and after a change, with structure varying by activity type.

Example API Response

{
  "type": "admin_activity_log_event",
  "id": "762d17eb-3072-464b-be81-bfd904f2eaf1",
  "performed_by": {
    "type": "admin",
    "id": "144",
    "email": "admin@example.com",
    "ip": "154.61.86.89"
  },
  "metadata": {
    "before": {
      "initial_inactivity_threshold": 40
    },
    "after": {
      "initial_inactivity_threshold": 41
    }
  },
  "created_at": 1763990263,
  "activity_type": "automatic_away_mode_setting_change",
  "activity_description": "Admin updated automatic away mode settings."
}

Pattern Alignment

  • Follows the established pattern for activity log event types
  • The before/after metadata fields are generic objects that can be reused by multiple activity types
  • Only affects API version 2.14 (not Unstable)

Related Issues & PRs

Intercom Monolith:

  • intercom/intercom#448699 - Backend implementation (event model, commands, presenters)

Frontend:

  • intercom/intercom#448718 - Embercom UI for displaying events

Developer Docs:

  • intercom/developer-docs#662 - Documentation updates

OpenAPI Spec:

  • intercom/intercom#448720 - This OpenAPI spec issue

Reference:

@Rosie-Kennelly-1 Rosie-Kennelly-1 changed the title Update OpenAPI spec for automatic_away_mode_setting_change Add automatic_away_mode_setting_change to activity log event types Nov 24, 2025
@Rosie-Kennelly-1 Rosie-Kennelly-1 marked this pull request as ready for review November 24, 2025 16:09
@Rosie-Kennelly-1 Rosie-Kennelly-1 merged commit 8d34faf into main Nov 24, 2025
6 checks passed
@Rosie-Kennelly-1 Rosie-Kennelly-1 deleted the rkennelly/automatic-away-mode-openapi-spec branch November 24, 2025 16:14
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.

4 participants