Skip to main content

App Events

Manage App Store in-app events for your iOS apps
The app-events command provides management of in-app events, which are timely occurrences in your app or game that you can showcase on the App Store.

Overview

In-app events help users discover engaging experiences within your app:
  • Event Types - Challenges, competitions, live events, major updates, new seasons, and premieres
  • Scheduling - Set start/end times and publish dates
  • Territories - Control where events appear
  • Localizations - Provide event details in multiple languages
  • Media - Showcase events with screenshots and video previews

List App Events

List all in-app events for an app.
Required Flags:
  • --app - App ID (or ASC_APP_ID env)
Optional Flags:
  • --limit - Results per page (1-200)
  • --paginate - Fetch all pages
  • --next - Pagination URL
Example:

Get Event Details

Retrieve details for a specific event.
Required Flags:
  • --event-id - App event ID

Create App Event

Create a new in-app event.
Required Flags:
  • --app - App ID (or ASC_APP_ID env)
  • --name - Reference name (internal identifier)
  • --event-type - Event badge type (see Event Types)
Optional Flags:
  • --start - Event start time (RFC3339 format)
  • --end - Event end time (RFC3339 format)
  • --publish-start - Publish start time (when event appears on App Store)
  • --territories - Comma-separated territory codes (e.g., USA,CAN,GBR)
  • --deep-link - Deep link URL to open event in app
  • --purchase-requirement - Currently supported: NO_COST_ASSOCIATED
  • --primary-locale - Primary locale (e.g., en-US)
  • --priority - Priority: HIGH, NORMAL (see Priority)
  • --purpose - Purpose: see Purpose values
Examples:

Update App Event

Update an existing app event.
Required Flags:
  • --event-id - Event ID to update
Optional Flags:
  • --name - Reference name
  • --event-type - Event badge type
  • --start - Event start time
  • --end - Event end time
  • --publish-start - Publish start time
  • --territories - Territory codes
  • --deep-link - Deep link URL
  • --purchase-requirement - Purchase requirement
  • --primary-locale - Primary locale
  • --priority - Priority level
  • --purpose - Event purpose
Examples:

Delete App Event

Delete an app event.
Required Flags:
  • --event-id - Event ID to delete
  • --confirm - Confirm deletion

Event Types

Event types determine the badge shown on the App Store:
  • CHALLENGE - In-app challenges or quests
  • COMPETITION - Competitive events or tournaments
  • LIVE_EVENT - Live streaming or real-time events
  • MAJOR_UPDATE - Significant app updates
  • NEW_SEASON - New season or content drops
  • PREMIERE - Content or feature premieres
  • SPECIAL_EVENT - Other special occasions
Badge Selection:
  • Choose the badge that best represents your event
  • Users filter events by type on the App Store
  • Consistent badge usage improves discoverability

Priority

Priority determines event prominence on the App Store:
  • HIGH - Featured prominently; limited to 5 active events per app
  • NORMAL - Standard display; no limit on active events
Best Practices:
  • Reserve HIGH priority for your most important events
  • Plan ahead to stay within the 5-event limit
  • Use NORMAL for recurring or minor events

Purpose

Purpose helps App Store Connect categorize your event:
  • APPROPRIATE_FOR_ALL_USERS - Suitable for all audiences
  • ATTRACT_NEW_USERS - Designed to attract new users
  • BRING_BACK_LAPSED_USERS - Re-engage inactive users
  • KEEP_ACTIVE_USERS_INFORMED - Keep current users engaged

Date and Time Format

All dates use RFC3339 format with UTC timezone:
Examples:
  • 2026-06-01T00:00:00Z - June 1, 2026 at midnight UTC
  • 2026-07-15T18:30:00Z - July 15, 2026 at 6:30 PM UTC
Converting from Local Time:

Localizations

Provide localized event details for different languages.
Required Fields:
  • Name (30 characters max)
  • Short description (50 characters max)
  • Long description (120 characters max)

Screenshots

Upload event screenshots to showcase your event.
Screenshot Requirements:
  • Format: PNG or JPG
  • Dimensions: Match device screen sizes (e.g., 1284 x 2778 for iPhone 13 Pro Max)
  • Maximum file size: 8MB
  • Minimum: 1 screenshot per localization
  • Maximum: 8 screenshots per localization

Video Clips

Add video previews to highlight your event.
Video Requirements:
  • Format: .mov, .mp4, .m4v
  • Duration: 15-30 seconds
  • Resolution: Minimum 1920 x 1080
  • Maximum file size: 500MB
  • Frame rate: 23.976-30 fps

Relationships

View relationships between events and other resources.

Submission

Submit an app event for App Store review.
Requirements before submission:
  • At least one localization
  • At least one screenshot per localization
  • Event dates configured
  • All required metadata fields completed

Common Workflows

Create Complete Event

Schedule Seasonal Events

Export Event Schedule

Best Practices

Event Planning

  • Plan events at least 2 weeks in advance for review
  • Align event timing with actual in-app content availability
  • Don’t overlap too many high-priority events
  • Consider timezone differences for global audiences

Event Types

  • Choose the most accurate badge type
  • Be consistent with badge usage across similar events
  • Don’t use “Major Update” for minor changes
  • Reserve “Live Event” for truly live experiences

Localizations

  • Localize for all languages your app supports
  • Keep descriptions concise and compelling
  • Highlight what makes the event unique
  • Use action-oriented language

Media

  • Show actual event content, not generic app screenshots
  • Use high-quality images that stand out
  • Include a video for high-priority events
  • Update media to reflect current event state

Timing

  • Set publish start before event start to build anticipation
  • Don’t set event end too far in the future (reduces urgency)
  • Update or remove events that are delayed
  • Archive completed events promptly

Limitations

  • Maximum 5 high-priority events active at once
  • Maximum 10 total active events per app
  • Events must be approved before they appear on the App Store
  • Minimum event duration: No enforced minimum (use judgment)
  • Maximum event duration: No enforced maximum (shorter events typically perform better)

API Reference