Skip to main content
GET
TypeScript

인증

Authorization
string
header
필수

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

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

Webhook ID, prefixed hook_.

응답

legacy webhook testable events use dot-form names

api_version
enum<string>
필수

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

사용 가능한 옵션:
v1,
v2,
v5
예시:

"v1"

api_version_date
string | null
필수

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.

예시:

"2026-01-01"

child_resource_events
boolean
필수

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

예시:

false

consecutive_failures
integer
필수

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.

예시:

9

created_at
string
필수

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

예시:

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

disabled_at
string | null
필수

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.

예시:

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

disabled_reason
enum<string> | null
필수

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

사용 가능한 옵션:
delivery_failures,
null
예시:

"delivery_failures"

enabled
boolean
필수

Whether this webhook endpoint is currently active and receiving events.

예시:

false

events
enum<string>[]
필수

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

사용 가능한 옵션:
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
필수

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.

예시:

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

id
string
필수

Webhook ID, prefixed hook_.

예시:

"hook_xxxxxxxxxxxxxx"

last_failure_at
string | null
필수

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

예시:

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

resource_id
string
필수

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

예시:

"biz_xxxxxxxxxxxxxx"

testable_events
enum<string>[]
필수

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

사용 가능한 옵션:
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
필수

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

예시:

"Production"

url
string
필수

Destination URL where webhook payloads are delivered via HTTP POST.

예시:

"https://example.com/hooks"

webhook_secret
string | null
필수

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.

예시:

"ws_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"