Skip to main content
WEBHOOK
paywall.balance.deposit.created
{
  "id": "paywall_balance_deposit_created_evt_123",
  "paywallId": "pw_live_123",
  "ownerUserId": "usr_owner_789",
  "type": "paywall.balance.deposit.created",
  "version": "2024-05-01",
  "createdAt": "2024-05-01T12:34:56Z",
  "status": "pending",
  "attempts": 1,
  "data": {
    "paywallId": "pw_live_123",
    "ownerUserId": "usr_owner_789",
    "walletUserId": "wallet_123",
    "externalUserId": "external_456",
    "amount": 50,
    "currency": "USD",
    "source": "stripe.checkout",
    "activityId": "act_9001"
  }
}

Body

application/json

Paywall event payload that triggered the webhook delivery.

​
id
string
required
​
paywallId
string
required
​
type
enum<string>
required

Event key (see the webhooks section for the full catalog).

Available options:
TitleConst
paywall.balance.deposit.created
​
version
string
required
​
createdAt
string<date-time>
required
​
status
string
required
​
attempts
integer
required
​
data
object
required

Event-specific payload delivered with the webhook. Structure depends on the event type. Payload fields: paywallId, ownerUserId, walletUserId, externalUserId, amount, currency, source, activityId.

​
ownerUserId
string
​
metadata
object
​
trigger
object
​
subject
object

Response

200

Return a 2xx to acknowledge receipt.