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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.paywalls.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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:
paywall.updated,
paywall.archived,
paywall.secret.rotated,
paywall.integration.connected,
paywall.integration.disconnected,
paywall.integration.stripe.webhook.rotated,
paywall.authorization.requested,
paywall.authorization.completed,
paywall.authorization.revoked,
paywall.authorization.declined,
paywall.balance.deposit.created,
paywall.balance.topup.link.created,
paywall.balance.trial.granted,
paywall.balance.charge.created,
paywall.balance.charge.completed,
paywall.balance.charge.failed,
paywall.usage.charge.created,
paywall.usage.charge.deferred,
paywall.usage.rate.limited,
paywall.balance.depleted,
paywall.request.blocked,
paywall.stripe.checkout.session.completed,
paywall.proxy.request.started,
paywall.proxy.request.completed,
paywall.proxy.request.failed,
paywall.proxy.request.canceled,
paywall.proxy.request.blocked
Allowed value: "paywall.balance.deposit.created"
​
version
string
required
​
createdAt
string<date-time>
required
​
status
string
required
​
attempts
integer
required
​
data
object
required

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.