Skip to main content
PATCH
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

developer:manage_webhook

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

Webhook ID, prefixed hook_.

Body

application/json
api_version_date
string | null

The dated API version (Api-Version-Date) to pin this webhook's payloads to. Only valid for v1 webhooks. Omit to leave the current pin unchanged, or pass null to unpin and track the current payload shape.

Voorbeeld:

"2026-01-01"

child_resource_events
boolean

Whether or not to send events for child resources.

Voorbeeld:

true

enabled
boolean

Whether or not the webhook is enabled.

Voorbeeld:

false

events
enum<string>[]

The events to send the webhook for, in dot form (for example payment.succeeded).

Beschikbare opties:
account.updated,
account.financing_approved,
account.financing_denied,
account.financing_disabled,
invoice.created,
invoice.marked_uncollectible,
invoice.paid,
invoice.past_due,
invoice.voided,
membership.activated,
membership.deactivated,
membership.trial_ending_soon,
membership.updated,
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,
financial_activity.funds_available,
transfer.created,
transfer.completed,
transfer.failed,
payout.created,
payout.updated,
payout.reversed,
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,
domain.created,
domain.updated,
domain.deleted,
capital.created,
capital.updated,
payout_method.created,
verification.succeeded,
identity_profile.approved,
identity_profile.rejected,
identity_profile.needs_action,
identity_profile.updated,
payout_account.status_updated,
payment.authorized,
payment.canceled,
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,
member.updated,
ad_campaign.created,
ad_campaign.payment_failed,
ad_campaign.updated,
ad_campaign.events,
ad_campaign.deleted,
ad_group.created,
ad_group.updated,
ad_group.deleted,
ad.created,
ad.updated,
ad.deleted,
app_installation.created,
app_installation.deleted,
events.created,
chat.message.created,
chat.reaction.created,
payment.created,
payment.succeeded,
payment.failed,
payment.pending,
payment.requires_action,
dispute.created,
dispute.updated,
refund.created,
refund.updated,
dispute_alert.created,
membership.cancel_at_period_end_changed,
shipping_address.changed
title
string | null

A label for the webhook, shown in the dashboard. Up to 255 characters. Pass null or an empty string to remove it.

Maximum string length: 255
Voorbeeld:

"Staging"

url
string

The URL to send the webhook to.

Voorbeeld:

"https://example.com/shine-time/whop-updated"

Respons

webhook updated

api_version
enum<string>
vereist

The API version used to format payloads sent to this webhook endpoint.

Beschikbare opties:
v1,
v2,
v5
Voorbeeld:

"v1"

api_version_date
string | null
vereist

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.

Voorbeeld:

"2026-01-01"

child_resource_events
boolean
vereist

Whether events are sent for child resources. For example, if the webhook is on an account, enabling this sends events only from its subaccounts.

Voorbeeld:

false

consecutive_failures
integer
vereist

Number of consecutive deliveries whose first attempt to this endpoint failed since it last accepted one. Later retries of the same delivery do not increment it. Resets to 0 when a delivery succeeds or the webhook is re-enabled.

Voorbeeld:

9

created_at
string
vereist

When the webhook was created, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

disabled_at
string | null
vereist

When Whop automatically disabled this webhook, as an ISO 8601 timestamp. null unless the webhook was disabled by Whop; a webhook you disabled yourself has enabled: false and a null disabled_at.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

disabled_reason
enum<string> | null
vereist

Why Whop disabled this webhook. delivery_failures means every delivery failed for 3 days straight. null when disabled_at is null.

Beschikbare opties:
delivery_failures,
null
Voorbeeld:

"delivery_failures"

enabled
boolean
vereist

Whether this webhook endpoint is currently active and receiving events.

Voorbeeld:

false

events
enum<string>[]
vereist

Event types this webhook is subscribed to, in dot form (for example payment.succeeded).

Beschikbare opties:
account.updated,
account.financing_approved,
account.financing_denied,
account.financing_disabled,
invoice.created,
invoice.marked_uncollectible,
invoice.paid,
invoice.past_due,
invoice.voided,
membership.activated,
membership.deactivated,
membership.trial_ending_soon,
membership.updated,
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,
financial_activity.funds_available,
transfer.created,
transfer.completed,
transfer.failed,
withdrawal.created,
withdrawal.updated,
withdrawal.reversed,
payout.created,
payout.updated,
payout.reversed,
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,
domain.created,
domain.updated,
domain.deleted,
capital.created,
capital.updated,
payout_method.created,
verification.succeeded,
identity_profile.approved,
identity_profile.rejected,
identity_profile.needs_action,
identity_profile.updated,
payout_account.status_updated,
payment.authorized,
payment.canceled,
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,
member.updated,
ad_campaign.created,
ad_campaign.payment_failed,
ad_campaign.updated,
ad_campaign.events,
ad_campaign.deleted,
ad_group.created,
ad_group.updated,
ad_group.deleted,
ad.created,
ad.updated,
ad.deleted,
app_installation.created,
app_installation.deleted,
events.created,
chat.message.created,
chat.reaction.created,
payment.created,
payment.succeeded,
payment.failed,
payment.pending,
payment.requires_action,
dispute.created,
dispute.updated,
refund.created,
refund.updated,
dispute_alert.created,
membership.cancel_at_period_end_changed,
membership.went_valid,
membership.went_invalid,
membership.metadata_updated,
resolution.created,
resolution.updated,
resolution.decided,
payment.affiliate_reward_created,
membership.experience_claimed,
app_membership.went_valid,
app_membership.went_invalid,
app_payment.created,
app_payment.succeeded,
app_payment.failed,
app_payment.pending,
app_payment.requires_action,
app_membership.cancel_at_period_end_changed,
shipping_address.changed
failing_since
string | null
vereist

When the current failure streak began, as an ISO 8601 timestamp. Unlike last_failure_at, this is set on the streak's first failed attempt, so it shows an endpoint that is failing right now. null when the endpoint is healthy.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

id
string
vereist

Webhook ID, prefixed hook_.

Voorbeeld:

"hook_xxxxxxxxxxxxxx"

last_failure_at
string | null
vereist

When a delivery to this endpoint most recently failed after exhausting retries, as an ISO 8601 timestamp. null if no delivery has ever failed.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

resource_id
string
vereist

ID of the resource (account or app) this webhook is attached to.

Voorbeeld:

"biz_xxxxxxxxxxxxxx"

testable_events
enum<string>[]
vereist

The subset of subscribed event types that support sending test payloads, in dot form.

Beschikbare opties:
account.updated,
account.financing_approved,
account.financing_denied,
account.financing_disabled,
invoice.created,
invoice.marked_uncollectible,
invoice.paid,
invoice.past_due,
invoice.voided,
membership.activated,
membership.deactivated,
membership.trial_ending_soon,
membership.updated,
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,
financial_activity.funds_available,
transfer.created,
transfer.completed,
transfer.failed,
withdrawal.created,
withdrawal.updated,
withdrawal.reversed,
payout.created,
payout.updated,
payout.reversed,
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,
domain.created,
domain.updated,
domain.deleted,
capital.created,
capital.updated,
payout_method.created,
verification.succeeded,
identity_profile.approved,
identity_profile.rejected,
identity_profile.needs_action,
identity_profile.updated,
payout_account.status_updated,
payment.authorized,
payment.canceled,
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,
member.updated,
ad_campaign.created,
ad_campaign.payment_failed,
ad_campaign.updated,
ad_campaign.events,
ad_campaign.deleted,
ad_group.created,
ad_group.updated,
ad_group.deleted,
ad.created,
ad.updated,
ad.deleted,
app_installation.created,
app_installation.deleted,
events.created,
chat.message.created,
chat.reaction.created,
payment.created,
payment.succeeded,
payment.failed,
payment.pending,
payment.requires_action,
dispute.created,
dispute.updated,
refund.created,
refund.updated,
dispute_alert.created,
membership.cancel_at_period_end_changed,
membership.went_valid,
membership.went_invalid,
membership.metadata_updated,
resolution.created,
resolution.updated,
resolution.decided,
payment.affiliate_reward_created,
membership.experience_claimed,
app_membership.went_valid,
app_membership.went_invalid,
app_payment.created,
app_payment.succeeded,
app_payment.failed,
app_payment.pending,
app_payment.requires_action,
app_membership.cancel_at_period_end_changed,
shipping_address.changed
title
string | null
vereist

A label for this webhook endpoint, such as Production, shown in the dashboard. null if no title was set.

Voorbeeld:

"Production"

url
string
vereist

Destination URL where webhook payloads are delivered via HTTP POST.

Voorbeeld:

"https://example.com/hooks"

webhook_secret
string | null
vereist

Secret key used to sign webhook payloads. Use it to verify the HMAC signature of each delivery. Returned in the create response. null on later reads by API keys and OAuth apps.

Voorbeeld:

"ws_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"