App Store Connect Webhook Integration
Learn how to integrate App Store Connect webhooks with Echobell for instant app status notifications and TestFlight feedback alerts
App Store Connect Webhook Integration
App Store Connect provides webhook functionality to send real-time notifications about app status changes and TestFlight feedback directly to your server. By integrating App Store Connect webhooks with Echobell, you can receive instant notifications on your mobile device whenever important events occur with your iOS apps.
App Store Connect webhooks are available to developers with Account Holder, Admin, or App Manager roles. Each webhook can only apply to one app, and you can create up to ten webhooks per app.
Prerequisites
- An Echobell account with at least one channel created
- Access to App Store Connect with Account Holder, Admin, or App Manager role
- An active iOS app in App Store Connect
- Your Echobell webhook URL (available in your channel settings)
What You Can Monitor
App Store Connect webhooks can notify you about:
-
App Version Status Changes
- App submission status updates
- App review approval or rejection
- App release to the App Store
- Version updates going live
-
TestFlight Events
- New TestFlight feedback from beta testers
- Build processing completion
- Tester invitation status changes
Setup Overview
- Create and configure an Echobell channel
- Set up notification templates for App Store Connect events
- Get your Echobell webhook URL
- Create and configure webhook in App Store Connect
- Test the integration
Step-by-Step Guide
1. Create an Echobell Channel
- Open the Echobell app
- Create a new channel (e.g., "App Store Connect")
- Choose a distinctive color and icon for easy identification
- Add team members who should receive app status notifications
2. Configure Notification Templates
Set up templates that will format your App Store Connect events effectively:
Title Template:
Body Template:
3. Get Your Echobell Webhook URL
- In your Echobell channel settings, navigate to the Triggers section
- Copy the webhook URL provided
- Keep this URL secure as it will be configured in App Store Connect
4. Configure App Store Connect Webhook
According to Apple's official documentation, follow these steps:
Create a Webhook
- Sign in to App Store Connect
- Navigate to Users and Access
- Click Integrations in the sidebar
- Under Additional, click Webhooks
- Click the add button (+) next to Webhooks
- Configure your webhook:
- Name: Enter a descriptive name (e.g., "Echobell Notifications")
- Payload URL: Paste your Echobell webhook URL
- Secret: Create a secure secret string for authentication
- App: Select the app you want to monitor
- Event Triggers: Select the events you want to receive notifications for
Available Event Triggers
Select from these event types based on your monitoring needs:
App Version Events:
- App Store Version State Changed: When your app's review status changes
- App Store Version Released: When your app version is released to the App Store
TestFlight Events:
- TestFlight Beta Feedback: When beta testers submit feedback
- TestFlight Beta Review State Changed: When TestFlight review status changes
- Click Add to create the webhook
5. Test Your Integration
-
After creating the webhook, use App Store Connect's built-in test feature:
- In the webhook list, click on your newly created webhook
- Click Test in the top right corner
- A test ping will be sent to your Echobell channel
-
You should receive a test notification in Echobell with event type "Ping"
Advanced Configuration
Webhook Security
To enhance security and verify webhook authenticity:
- Use HTTPS: Echobell webhook URLs use HTTPS by default
- Secret Verification: Use the secret you configured to verify incoming requests
- IP Allowlisting: Consider allowlisting Apple's webhook delivery IP ranges
Custom Notification Templates
Customize your templates based on different event types:
For App Status Changes:
- Title Template:
- Body Template:
- Link Template:
For TestFlight Feedback:
- Title Template:
- Body Template:
- Link Template:
Managing Multiple Apps
For teams managing multiple apps:
- Create separate channels for each app or app category
- Use descriptive naming conventions (e.g., "MyApp - Production", "MyApp - Beta")
- Configure different notification schedules for different apps
- Set up role-based channel subscriptions
Webhook Payload Structure
App Store Connect sends webhook payloads in JSON format. Here's the typical structure:
Managing Webhooks
View Webhook Deliveries
Monitor your webhook performance in App Store Connect:
- Go to Users and Access → Integrations → Webhooks
- Click on your webhook
- Review Recent Deliveries section to see:
- Event ID and type
- Delivery status (Success, Pending, Failed)
- Creation date
- Response details
Webhook Delivery Status
Status | Description |
---|---|
Success | Webhook was successfully delivered to Echobell |
Pending | Webhook is in the process of being delivered |
Failed | Webhook delivery failed (can be resent) |
Resend Failed Deliveries
If a webhook delivery fails:
- In the Recent Deliveries table, locate the failed delivery
- Click Resend next to the failed event
- A new delivery attempt will be made
Modify Webhook Settings
You can update webhook settings at any time:
- Click on the webhook you want to modify
- Update the name, secret, payload URL, or event triggers
- Click Save
- Changes take effect immediately
Temporarily Disable Webhooks
To pause notifications without deleting the webhook:
- Click on the webhook
- Click Turn Off Webhook
- Click Confirm
- To re-enable, click Turn On Webhook
Use Cases and Examples
Development Team Workflows
Scenario 1: App Release Monitoring
- Monitor when your app moves from "In Review" to "Ready for Sale"
- Get notified immediately when new versions are available to users
- Track the entire submission and review process
Scenario 2: TestFlight Beta Management
- Receive instant feedback from beta testers
- Monitor beta build processing status
- Track tester engagement and feedback trends
Scenario 3: Multi-App Portfolio Management
- Set up separate channels for different apps
- Configure role-based notifications for team members
- Create summary reports for stakeholders
Notification Strategies
For Small Teams:
- Single channel for all app events
- Include all team members
- Use detailed templates with full context
For Large Organizations:
- Separate channels by app and environment
- Role-based channel access (developers, QA, marketing)
- Escalation channels for critical events
Troubleshooting
Common Issues
Not Receiving Notifications:
- Verify webhook URL: Ensure the Echobell webhook URL is correctly configured
- Check event triggers: Confirm you've selected the appropriate event types
- Review delivery status: Check App Store Connect's Recent Deliveries for errors
- Validate channel status: Ensure your Echobell channel is active
- Confirm subscriptions: Verify team members are subscribed to the channel
Webhook Authentication Errors:
- Secret mismatch: Verify the secret configured in App Store Connect matches your expectations
- URL accessibility: Ensure the Echobell webhook URL is publicly accessible
- SSL certificates: Confirm HTTPS connectivity is working properly
Missing Event Data:
- Template variables: Check that your notification templates use correct variable names
- Event type filtering: Verify you're subscribed to the correct event types
- Payload parsing: Review the webhook payload structure for available data fields
Testing Webhooks
Using App Store Connect Test Feature:
- Navigate to your webhook in App Store Connect
- Click the Test button
- Verify you receive the ping notification in Echobell
Manual Testing:
- Submit an app update or TestFlight build
- Monitor the webhook delivery status
- Check Echobell notifications for proper formatting
Rate Limiting and Performance
- App Store Connect may implement rate limiting on webhook deliveries
- Echobell handles webhook processing efficiently to minimize delays
- Consider notification frequency when configuring multiple webhooks
Best Practices
Security
- Keep webhook URLs private: Don't share your Echobell webhook URLs publicly
- Use strong secrets: Create complex, unique secrets for webhook authentication
- Monitor delivery logs: Regularly review webhook delivery status
- Rotate secrets periodically: Update webhook secrets regularly for security
Organization
- Consistent naming: Use clear, descriptive names for webhooks and channels
- Documentation: Document your webhook configurations for team reference
- Channel organization: Group related notifications in appropriate channels
- Access control: Manage channel subscriptions based on team roles
Monitoring
- Regular health checks: Test webhooks periodically to ensure they're working
- Performance monitoring: Track webhook delivery success rates
- Error alerting: Set up notifications for webhook delivery failures
- Capacity planning: Monitor notification volume and adjust accordingly
API Integration
For advanced use cases, you can also manage webhooks programmatically using the App Store Connect API. This allows you to:
- Automate webhook creation for new apps
- Programmatically update webhook configurations
- Integrate webhook management into your CI/CD pipelines
- Monitor webhook performance metrics
Related Resources
- Apple's Official Webhook Documentation
- App Store Connect API Documentation
- TestFlight Beta Testing Guide
- App Store Review Guidelines
Conclusion
Integrating App Store Connect webhooks with Echobell provides real-time visibility into your app's status and TestFlight feedback. This integration helps development teams stay informed about critical app events, respond quickly to review feedback, and maintain better communication throughout the app development lifecycle.
The combination of App Store Connect's reliable webhook delivery and Echobell's flexible notification system creates a powerful monitoring solution for iOS app developers and teams of all sizes.