#
app.uninstalled
#
Introduction
The app.uninstalled webhook is triggered when a merchant uninstalls your app from the Armada Marketplace. Armada immediately removes the integration and sends this webhook to your registered Uninstall URL for cleanup purposes.
The integration will be removed regardless of your webhook response. The webhook is purely informational for your cleanup operations.
For more details on webhook configuration, see the App Creation section.
#
Webhook Request
When a merchant uninstalls your app, Armada sends a POST request to your configured uninstall URL.
#
Payload Headers
These are the useful headers you need. The request may include additional headers, but these are the essential ones:
#
Payload Schema
{
"reason": "String" // Uninstall reason
}
#
Payload Example
{
"reason": "user_initiated"
}
#
Response Requirements
Your webhook endpoint must respond with a 200 status code, even if cleanup operations fail. Log errors separately but don't block the uninstall process.
#
Best Practices
Identify the Merchant: Use x-armada-app-id and x-armada-installation-id headers together to identify which merchant installation is being removed.
Respond Quickly: Return 200 OK immediately, then perform cleanup operations asynchronously.
Handle Idempotency: Use x-armada-webhook-id to track processed webhooks and prevent duplicate cleanup operations.
Clean Up Properly: Remove or archive merchant data, revoke stored access tokens, and comply with data retention policies.
Log Everything: Record uninstall events for audit trails and analytics purposes.