Rc Webhooks

RevenueCat/ai-toolkit/revenuecat-play-billing/skills/rc-webhooks

作者 RevenueCatccfc038185ec457b2ac9077f3bbf1ba947a44dbbApache-2.0; see LICENSE收錄於 2026年10月9日更新於 2026年10月9日

Use this skill when consuming RevenueCat webhooks on your backend. Covers the normalized event schema, the full event type list, idempotency via the event id field, and the correct handling for CANCELLATION versus EXPIRATION versus RENEWAL.

AI 產生的概覽

指導後端處理 RevenueCat Webhook:事件結構、冪等性以及依事件類型處理權益的邏輯。

功能
此技能指導代理在伺服器端消費 RevenueCat Webhook。它說明正規化 JSON 事件外層結構、完整的事件類型清單、使用事件 id 欄位進行去重,以及 CANCELLATION、EXPIRATION 與 RENEWAL 的正確處理方式。它也提供 Kotlin 處理程式範例,以及涵蓋簽章驗證、重播處理和權益狀態變更的驗證清單。
適用情境
適用於建置接收 RevenueCat Webhook 事件的後端端點時。適合需要將事件類型對應為權益授予、撤銷或排程撤銷的情境。也適合檢視現有 Webhook 處理程式中的冪等性以及取消與到期處理錯誤。
執行需求
需要一個接受 JSON 內文 POST 要求的伺服器端 HTTPS 端點、來自 RevenueCat 後台的 Webhook 密鑰,以及用於記錄已處理事件 ID 和權益狀態的持久化儲存。此技能不附帶指令碼,僅包含說明和程式碼範例。

RevenueCat Webhooks

You configure one endpoint. RevenueCat posts one normalized JSON event schema for every store. Your job on the server side is to verify the signature, deduplicate by event.id, and dispatch per event type.

Phase 1: Discover

Confirm what you are wiring up before touching code.

  • You own a server side HTTPS endpoint that accepts POST with a JSON body.
  • You have the webhook secret from the RevenueCat dashboard under Integrations then Webhooks.
  • You have durable storage to record processed event IDs and entitlement state per app_user_id.
  • You understand that RevenueCat has already mapped products to entitlements, so you branch on event.type and read event.entitlement_ids. You do not maintain a product to entitlement table on your backend.

Every event has this outer shape:

json
{  "api_version": "1.0",  "event": {    "id": "evt_01HABCXYZ0000000000000001",    "type": "INITIAL_PURCHASE",    "app_user_id": "user_12345",    "product_id": "premium_monthly",    "period_type": "NORMAL",    "purchased_at_ms": 1700000000000,    "expiration_at_ms": 1702592000000,    "store": "PLAY_STORE",    "environment": "PRODUCTION",    "entitlement_ids": ["pro_access"],    "transaction_id": "GPA.1234-5678-9012-34567"  }}

Phase 2: Plan

Pick the right action for each event type before you write the handler.

Event typeMeaningHandler action
INITIAL_PURCHASEFirst paid transaction for this user and product.Grant entitlements in entitlement_ids.
RENEWALSubscription renewed, including resubscription after an EXPIRATION.Grant or extend entitlements in entitlement_ids.
CANCELLATIONUser turned off auto renew. Access continues until expiration_at_ms.Schedule revocation at expiration_at_ms. Do not revoke now.
UNCANCELLATIONUser re enabled auto renew before expiry.Cancel any scheduled revocation. Keep entitlements active.
EXPIRATIONSubscription actually ended.Revoke entitlements now.
BILLING_ISSUEPayment failed. User may be in grace period or on hold.Flag the account. Do not revoke yet. RevenueCat sends EXPIRATION if recovery fails.
PRODUCT_CHANGEUser switched plan (upgrade, downgrade, or cross grade).Update the product on record. Entitlement state follows entitlement_ids.
SUBSCRIBER_ALIASTwo app user IDs were merged into one identity.Merge your local records for the aliased IDs.
TRANSFERA transaction moved from one app user ID to another.Move entitlements from the old ID to the new ID.

Key decisions baked into this table:

  • CANCELLATION is not an access change. It is an intent signal. Revoking now is a bug that deletes paid access the user still owns.
  • EXPIRATION is the access change. This is when you revoke.
  • Resubscription after an EXPIRATION fires RENEWAL, not INITIAL_PURCHASE. Your RENEWAL branch must be safe to run against a user whose entitlements are currently revoked, which means it must grant, not just extend.
  • BILLING_ISSUE is not revocation. Revoking on BILLING_ISSUE cuts off users who are still inside Google Play grace period or account hold.

Phase 3: Execute

Wire up a handler that verifies, deduplicates, and dispatches.

Verify the signature and parse

kotlin
post("/revenuecat/webhook") {    val body = call.receiveText()    val signature = call.request.headers["X-RevenueCat-Signature"]    if (!verifySignature(body, signature, webhookSecret)) {        call.respond(HttpStatusCode.Unauthorized); return@post    }    val event = Json.decodeFromString<RevenueCatEnvelope>(body).event    handleEvent(event)    call.respond(HttpStatusCode.OK)}

Return 2xx as soon as the event is persisted. If processing is slow, enqueue it and acknowledge. A slow handler causes retries and duplicate deliveries.

Deduplicate on event.id

RevenueCat can redeliver the same event. event.id is the idempotency key.

kotlin
suspend fun handleEvent(event: RcEvent) {    if (processedEvents.insertIfAbsent(event.id)) {        dispatch(event)    }    // Already processed: fall through, responder still returns 200.}

insertIfAbsent must be atomic in your store (a unique index on event_id plus an insert that swallows duplicate key errors works). Do all downstream writes in the same transaction as the event ID insert so a crash mid handler does not leave you with a marked but unapplied event.

Dispatch per type

kotlin
suspend fun dispatch(e: RcEvent) = when (e.type) {    "INITIAL_PURCHASE", "RENEWAL", "UNCANCELLATION" ->        db.grantEntitlements(e.appUserId, e.entitlementIds, e.expirationAtMs)    "CANCELLATION" ->        db.scheduleRevocation(e.appUserId, e.entitlementIds, e.expirationAtMs)    "EXPIRATION" ->        db.revokeEntitlements(e.appUserId, e.entitlementIds)    "BILLING_ISSUE" ->        db.flagBillingIssue(e.appUserId)    "PRODUCT_CHANGE" ->        db.updateProduct(e.appUserId, e.productId, e.entitlementIds)    "SUBSCRIBER_ALIAS", "TRANSFER" ->        db.mergeIdentity(e)    else -> Unit}

Notes that match the handbook:

  • grantEntitlements on RENEWAL must be idempotent and additive so a resubscribe after EXPIRATION restores access.
  • scheduleRevocation stores a pending job keyed by (app_user_id, entitlement_id) that fires at expiration_at_ms. If an UNCANCELLATION arrives first, cancel the job. If an EXPIRATION arrives first, let the EXPIRATION handler revoke and drop the pending job.

CANCELLATION payload (access continues)

json
{  "api_version": "1.0",  "event": {    "id": "evt_01HABCXYZ0000000000000010",    "type": "CANCELLATION",    "app_user_id": "user_12345",    "product_id": "premium_monthly",    "purchased_at_ms": 1700000000000,    "expiration_at_ms": 1702592000000,    "entitlement_ids": ["pro_access"],    "store": "PLAY_STORE",    "environment": "PRODUCTION"  }}

The user keeps pro_access until 1702592000000. Schedule revocation for that timestamp.

EXPIRATION payload (revoke now)

json
{  "api_version": "1.0",  "event": {    "id": "evt_01HABCXYZ0000000000000011",    "type": "EXPIRATION",    "app_user_id": "user_12345",    "product_id": "premium_monthly",    "expiration_at_ms": 1702592000000,    "entitlement_ids": ["pro_access"],    "store": "PLAY_STORE",    "environment": "PRODUCTION"  }}

Revoke pro_access for user_12345 as soon as you process this.

RENEWAL after expiry (resubscription)

When a lapsed user resubscribes, RevenueCat sends RENEWAL, not INITIAL_PURCHASE.

json
{  "api_version": "1.0",  "event": {    "id": "evt_01HABCXYZ0000000000000012",    "type": "RENEWAL",    "app_user_id": "user_12345",    "product_id": "premium_monthly",    "purchased_at_ms": 1705270400000,    "expiration_at_ms": 1707862400000,    "entitlement_ids": ["pro_access"],    "store": "PLAY_STORE",    "environment": "PRODUCTION"  }}

Your RENEWAL branch must grant entitlements, not assume they already exist. If you only extend an existing expiry, the resubscribed user stays locked out.

Verification Checklist

  • Signature verification rejects requests with missing or wrong X-RevenueCat-Signature.
  • A replayed event with the same event.id is a no op and still returns 200.
  • CANCELLATION does not revoke access. The user retains entitlements until expiration_at_ms.
  • EXPIRATION revokes access for the IDs in entitlement_ids.
  • A RENEWAL arriving after an EXPIRATION restores access for the same app_user_id.
  • BILLING_ISSUE flags the account without revoking.
  • Handler returns 2xx within your retry window even when downstream work is async.

References

來源與署名

來源:RevenueCat/ai-toolkit位於revenuecat-play-billing/skills/rc-webhooks提交ccfc038

授權條款: Apache-2.0; see LICENSE

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架