Understanding webhook events
Learn the events that describe payloads and the notifications the system sends.
Overview
Webhooks give you real-time, event-driven notifications via HTTP about payloads, so you can act on these events in an automated way. If enabled, you get notification from webhooks when one of the events you specify occurs. Use the webhook information to make subsequent calls to App Store Connect API to retrieve data.
Webhook events describe the payloads that the systems sends to your listening server based on your configurations when using Create a webhook configuration. To read a list of possible webhook event types, see WebhookEventType.
To learn more about setting up, testing, and parsing webhook configurations, see Configuring and parsing App Store Connect API webhook notifications.
Learn webhook event types
Here are three types of webhook event types; each includes different information, based on whether the systems notifies you about app status changes or beta-tester feedback crashes or screenshots.
- App status changes
Notifications that show when your app changes status, including review states.
- Build beta state changes
These notifications show when the external beta build status changes.
- Beta feedback
Notifications that show when beta testers report feedback with screenshots or crashes.
- Background Asset version state change
These notifications show when your background asset upload changes state during processing.
- Background Asset version internal beta release updates
These notifications show when your Background Asset version internal beta release is created or when the state changes with beta review.
- Background Asset App Store Release
These notifications show when a new background asset is available for App Store users.
- Build status changes
These notifications show when your build status changes.
- Alternative app marketplace changes
These notifications inform a marketplace about changes to apps it distributes.
The system sends a notification for these changes:
A new app version is available.
You need to remove a specific app version.
You need to remove all versions of an app.