App Events
Subscription App Events
Event Name | Description |
---|---|
app.market.application.authorized | Triggered when a merchant authorizes an app prior to installation. |
app.market.subscription.active | Send notification on successful activation of subscription. |
app.market.application.install | Send notification on the installation of the application. |
app.market.subscription.warning | Send notification 3 days before the last subscription date (T is the duration of the plan in days). |
app.market.subscription.suspended | Send notification on completion of subscription. |
app.market.subscription.expired | Send notification on T+5 days of subscription where 5 days are GRACE Period and T is in the duration of the plan in days. |
app.market.subscription.renew | Send notification on successful renewal of the same plan subscription 5 days before the last date. |
app.market.subscription.upgrade | Send notification on upgrade of subscription. |
app.market.subscription.refunded | Send notification on refund of subscription. |
app.market.application.uninstall | Send notification on uninstallation of the application. |
app.market.application.rated | Triggered when a merchant submits a rating or review for the app. |
app.market.private.plan.request | Triggered when a merchant submits a request for a private plan. |
Subscribing to App Events
Creating a Webhook Subscription
1.
2.
3.
4.
5.
Testing Webhooks Using a Development Store
1.
2.
3.
Webhook Event List and Payloads
1. App Authorized
Triggered when a merchant authorizes an app before installing it. This event ensures that the merchant has granted permissions required by the application.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "authorized",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.application.authorized",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
2. Subscription Activated
Sent when a subscription is successfully activated after payment.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "active",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.subscription.active",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
3. App Installed
Sent when an application is installed by a merchant.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "install",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.application.install",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
4. Subscription Warning
Sent 3 days before the last subscription date as a reminder to renew.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "warning",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.subscription.warning",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
5. Subscription Suspended
Sent when a subscription is suspended after expiration.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "suspended",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.subscription.suspended",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
6. Subscription Expired
Sent T+5 days after the subscription expires, where T is the plan duration and 5 days is the grace period.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "expired",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.subscription.expired",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
7. Subscription Renewed
Sent 5 days before the last subscription date when the same plan is successfully renewed.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "renew",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.subscription.renew",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
8. Subscription Upgraded
Sent when a merchant upgrades their subscription to a higher-tier plan.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "upgrade",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.subscription.upgrade",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
9. Subscription Refunded
Sent when a subscription payment is refunded to the merchant.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "refunded",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.subscription.refunded",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
10. App Uninstalled
Sent when a merchant uninstalls the application.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "uninstall",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.application.uninstall",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
11. App Rated
Triggered when a merchant submits a rating or review for the application.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "rated",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.application.rated",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
12. Private Plan Requested
Triggered when a merchant submits a request for a private plan.
{
"app_id": 1292,
"store_id": 507530,
"store_uuid": "d78468cd-4b44-4fee-a00d-76561f35787c",
"store_url": "https:\/\/wyatt.com.sa\/",
"plan_name": "\u0627\u0644\u0646\u0645\u0648",
"status": "request",
"start_date": "2025-02-21T08:05:29.000000Z",
"end_date": "2025-03-22T08:05:29.000000Z",
"amount_paid": 79.01,
"old_plan_name": null,
"merchant_email": "info@ehmp.com.sa",
"merchant_phone_no": "966554349999",
"event_name": "app.market.private.plan.request",
"plan_type": "Paid",
"plan_id": 904,
"payment_date": "2025-02-21T08:05:29.000000Z"
}
Modified at 2025-03-18 08:09:13