Skip to main content
​
ApiVersion
required
The API version used to format payloads sent to this webhook endpoint.Available options: v1, v2, v5
​
string | null
required
The dated API version (Api-Version-Date) that v1 payloads for this endpoint are pinned to: events serialize exactly like a REST read at this version (the native serializer where the resource has one). Null when unpinned — legacy (v2/v5) webhooks, and v1 webhooks on the legacy payload shape.
​
boolean
required
Whether events are sent for child resources. For example, if the webhook is on a company, enabling this sends events only from the company’s sub-merchants (child companies).
​
string<date-time>
required
The datetime the webhook was created.Example: 2023-12-01T05:00:00.401Z
​
boolean
required
Whether this webhook endpoint is currently active and receiving events.
​
array<WebhookEvent>
required
The list of event types this webhook is subscribed to.Available options: invoice.created, invoice.marked_uncollectible, invoice.paid, invoice.past_due, invoice.voided, membership.activated, membership.deactivated, membership.trial_ending_soon, entry.created, entry.approved, entry.denied, entry.deleted, export.completed, export.failed, setup_intent.requires_action, setup_intent.succeeded, setup_intent.canceled, ledger_account.funds_available, swap.completed, deposit.succeeded, transfer.created, transfer.completed, withdrawal.created, withdrawal.updated, card_transaction.created, card_transaction.updated, card_transaction.completed, card_transaction.declined, card_transaction.reversed, card.created, card.updated, card.frozen, card.canceled, card_application.created, card_application.updated, card_application.approved, card_application.denied, course_lesson_interaction.completed, payout_method.created, verification.succeeded, identity_profile.approved, identity_profile.rejected, identity_profile.needs_action, identity_profile.updated, payout_account.status_updated, resolution_center_case.created, resolution_center_case.updated, resolution_center_case.decided, product.created, product.updated, product.deleted, product.published, product.unpublished, plan.created, plan.updated, plan.deleted, shipment.created, shipment.updated, member.created, ad_campaign.payment_failed, chat.message.created, chat.reaction.created, payment.created, payment.succeeded, payment.failed, payment.pending, dispute.created, dispute.updated, refund.created, refund.updated, dispute_alert.created, membership.cancel_at_period_end_changed
​
string
required
The unique identifier for the webhook.Example: hook_xxxxxxxxxxxxx
​
string
required
The ID of the resource (company or product) this webhook is attached to.
​
array<WebhookEvent>
required
The subset of subscribed event types that support sending test payloads.Available options: invoice.created, invoice.marked_uncollectible, invoice.paid, invoice.past_due, invoice.voided, membership.activated, membership.deactivated, membership.trial_ending_soon, entry.created, entry.approved, entry.denied, entry.deleted, export.completed, export.failed, setup_intent.requires_action, setup_intent.succeeded, setup_intent.canceled, ledger_account.funds_available, swap.completed, deposit.succeeded, transfer.created, transfer.completed, withdrawal.created, withdrawal.updated, card_transaction.created, card_transaction.updated, card_transaction.completed, card_transaction.declined, card_transaction.reversed, card.created, card.updated, card.frozen, card.canceled, card_application.created, card_application.updated, card_application.approved, card_application.denied, course_lesson_interaction.completed, payout_method.created, verification.succeeded, identity_profile.approved, identity_profile.rejected, identity_profile.needs_action, identity_profile.updated, payout_account.status_updated, resolution_center_case.created, resolution_center_case.updated, resolution_center_case.decided, product.created, product.updated, product.deleted, product.published, product.unpublished, plan.created, plan.updated, plan.deleted, shipment.created, shipment.updated, member.created, ad_campaign.payment_failed, chat.message.created, chat.reaction.created, payment.created, payment.succeeded, payment.failed, payment.pending, dispute.created, dispute.updated, refund.created, refund.updated, dispute_alert.created, membership.cancel_at_period_end_changed
​
string
required
The destination URL where webhook payloads are delivered via HTTP POST.Example: https://example.com/path
​
string
required
The secret key used to sign webhook payloads for verification. Include this in your HMAC validation logic. Returned on the create response and to interactive dashboard sessions; empty for API-key and OAuth callers on later reads.Example: whsec_abc123def456