Skip to main content
POST
TypeScript

Autorisationer

Authorization
string
header
påkrævet

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

Overskrifter

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Eksempel:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Krop

application/json
url
string
påkrævet

The URL to send the webhook to.

Eksempel:

"https://example.com/hooks"

api_version_date
string | null

The dated API version (Api-Version-Date) to pin this webhook's payloads to. Omit to leave the webhook unpinned, tracking the current payload shape.

Eksempel:

"2026-01-01"

child_resource_events
boolean

Whether to send events for child resources. For example, if the webhook is created for an account, enabling this sends events only from its subaccounts.

Eksempel:

true

enabled
boolean

Whether or not the webhook is enabled. Defaults to true.

Eksempel:

true

events
enum<string>[]

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

Tilgængelige muligheder:
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
resource_id
string | null

The account or app to create the webhook for. Defaults to the current account.

Eksempel:

"biz_xxxxxxxxxxxxxx"

title
string | null

A label for the webhook, shown in the dashboard. Up to 255 characters.

Maximum string length: 255
Eksempel:

"Production"

Svar

webhook created

api_version
enum<string>
påkrævet

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

Tilgængelige muligheder:
v1,
v2,
v5
Eksempel:

"v1"

api_version_date
string | null
påkrævet

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.

Eksempel:

"2026-01-01"

child_resource_events
boolean
påkrævet

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

Eksempel:

false

consecutive_failures
integer
påkrævet

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.

Eksempel:

9

created_at
string
påkrævet

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

Eksempel:

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

disabled_at
string | null
påkrævet

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.

Eksempel:

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

disabled_reason
enum<string> | null
påkrævet

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

Tilgængelige muligheder:
delivery_failures,
null
Eksempel:

"delivery_failures"

enabled
boolean
påkrævet

Whether this webhook endpoint is currently active and receiving events.

Eksempel:

false

events
enum<string>[]
påkrævet

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

Tilgængelige muligheder:
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
påkrævet

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.

Eksempel:

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

id
string
påkrævet

Webhook ID, prefixed hook_.

Eksempel:

"hook_xxxxxxxxxxxxxx"

last_failure_at
string | null
påkrævet

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

Eksempel:

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

resource_id
string
påkrævet

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

Eksempel:

"biz_xxxxxxxxxxxxxx"

testable_events
enum<string>[]
påkrævet

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

Tilgængelige muligheder:
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
påkrævet

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

Eksempel:

"Production"

url
string
påkrævet

Destination URL where webhook payloads are delivered via HTTP POST.

Eksempel:

"https://example.com/hooks"

webhook_secret
string | null
påkrævet

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.

Eksempel:

"ws_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"