Skip to content

Commit a474468

Browse files
farukaydinclaude
andcommitted
docs: Add activity log event types API to Unstable spec
- Add new GET /admins/activity_log_event_types endpoint that returns all valid event type strings for admin activity logs - Add event_types[] query parameter to GET /admins/activity_logs for filtering logs by event type - Add activity_log_event_type_list schema Relates to intercom/intercom#478379, intercom/intercom#480911, intercom/intercom#481260, intercom/intercom#481894 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent b2616a7 commit a474468

File tree

1 file changed

+141
-0
lines changed

1 file changed

+141
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,19 @@ paths:
206206
example: '1677861493'
207207
schema:
208208
type: string
209+
- name: event_types[]
210+
in: query
211+
required: false
212+
description: An optional list of event types to filter activity logs by. When
213+
provided, only logs matching the specified event types are returned. Use
214+
the List all activity log event types endpoint to retrieve available values.
215+
schema:
216+
type: array
217+
items:
218+
type: string
219+
example:
220+
- admin_login_success
221+
- app_name_change
209222
tags:
210223
- Admins
211224
operationId: listActivityLogs
@@ -272,6 +285,113 @@ paths:
272285
message: Access Token Invalid
273286
schema:
274287
"$ref": "#/components/schemas/error"
288+
"/admins/activity_log_event_types":
289+
get:
290+
summary: List all activity log event types
291+
parameters:
292+
- name: Intercom-Version
293+
in: header
294+
schema:
295+
"$ref": "#/components/schemas/intercom_version"
296+
tags:
297+
- Admins
298+
operationId: listActivityLogEventTypes
299+
description: |
300+
You can get a list of all activity log event types. This is useful for discovering valid values to use with the `event_types[]` filter on the List all activity logs endpoint.
301+
responses:
302+
'200':
303+
description: Successful response
304+
content:
305+
application/json:
306+
examples:
307+
Successful response:
308+
value:
309+
type: activity_log_event_type.list
310+
event_types:
311+
- admin_conversation_assignment_limit_change
312+
- admin_ticket_assignment_limit_change
313+
- admin_away_mode_change
314+
- admin_deletion
315+
- admin_deprovisioned
316+
- admin_impersonation_end
317+
- admin_impersonation_start
318+
- admin_invite_change
319+
- admin_invite_creation
320+
- admin_invite_deletion
321+
- admin_login_failure
322+
- admin_login_success
323+
- admin_logout
324+
- admin_password_reset_request
325+
- admin_password_reset_success
326+
- admin_permission_change
327+
- admin_provisioned
328+
- admin_two_factor_auth_change
329+
- admin_unauthorized_sign_in_method
330+
- app_admin_join
331+
- app_authentication_method_change
332+
- app_data_deletion
333+
- app_data_export
334+
- app_google_sso_domain_change
335+
- app_identity_verification_change
336+
- app_name_change
337+
- app_outbound_address_change
338+
- app_package_installation
339+
- app_package_token_regeneration
340+
- app_package_uninstallation
341+
- app_team_creation
342+
- app_team_deletion
343+
- app_team_membership_modification
344+
- app_timezone_change
345+
- app_webhook_creation
346+
- app_webhook_deletion
347+
- articles_in_messenger_enabled_change
348+
- bulk_delete
349+
- bulk_export
350+
- campaign_deletion
351+
- campaign_state_change
352+
- conversation_part_deletion
353+
- conversation_topic_change
354+
- conversation_topic_creation
355+
- conversation_topic_deletion
356+
- help_center_settings_change
357+
- inbound_conversations_change
358+
- inbox_access_change
359+
- message_deletion
360+
- message_state_change
361+
- messenger_look_and_feel_change
362+
- messenger_search_required_change
363+
- messenger_spaces_change
364+
- office_hours_change
365+
- role_change
366+
- role_creation
367+
- role_deletion
368+
- ruleset_activation_title_preview
369+
- ruleset_creation
370+
- ruleset_deletion
371+
- search_browse_enabled_change
372+
- search_browse_required_change
373+
- seat_change
374+
- seat_revoke
375+
- security_settings_change
376+
- temporary_expectation_change
377+
- upfront_email_collection_change
378+
- welcome_message_change
379+
schema:
380+
"$ref": "#/components/schemas/activity_log_event_type_list"
381+
'401':
382+
description: Unauthorized
383+
content:
384+
application/json:
385+
examples:
386+
Unauthorized:
387+
value:
388+
type: error.list
389+
request_id: 85a1e5b6-e743-4e89-a6e2-1d7c0c3f4a5b
390+
errors:
391+
- code: unauthorized
392+
message: Access Token Invalid
393+
schema:
394+
"$ref": "#/components/schemas/error"
275395
"/admins":
276396
get:
277397
summary: List all admins
@@ -16444,6 +16564,27 @@ components:
1644416564
type: string
1644516565
description: A sentence or two describing the activity.
1644616566
example: Admin updated the app's name to "My App".
16567+
activity_log_event_type_list:
16568+
title: Activity Log Event Types
16569+
type: object
16570+
x-tags:
16571+
- Admins
16572+
description: A list of all activity log event types.
16573+
properties:
16574+
type:
16575+
type: string
16576+
description: String representing the object's type. Always has the value
16577+
`activity_log_event_type.list`.
16578+
example: activity_log_event_type.list
16579+
event_types:
16580+
type: array
16581+
description: An array of activity log event type strings.
16582+
items:
16583+
type: string
16584+
example:
16585+
- admin_login_success
16586+
- admin_logout
16587+
- app_name_change
1644716588
activity_log_list:
1644816589
title: Paginated Response
1644916590
type: object

0 commit comments

Comments
 (0)