Access tokens1

Account links1

Accounts15

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes6

Dm channels5

Dm members5

Domains5

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

Fee markups3

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members3

Memberships11

Messages5

Notifications6

Partner Referral Requests6

Partners7

Payment Method Domains5

Payment methods3

Payment Rules9

Payments12

Payout accounts1

Payout methods2

Payouts10

People2

Permissions1

Plans6

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews2

Setup Intents6

Shipments4

Social Accounts7

Stats2

Support channels3

Swaps4

Team Members5

Topups1

Trades5

Transfers4

Users18

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts3

Ad Campaigns2

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships4

Messages1

Payments7

Payout accounts1

Payouts4

Plans3

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Verifications2

Webhooks

Retrieve Webhook

Retrieves the details of an existing webhook.

get/webhooks/{id}

Response

legacy webhook testable events use dot-form names

api_version'v1' | 'v2' | 'v5' required

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

api_version_datestring nullable 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.

child_resource_eventsboolean required

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

consecutive_failuresinteger required

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.

created_atstring required

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

disabled_atstring nullable required

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.

disabled_reason'delivery_failures' | 'null' nullable required

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

enabledboolean required

Whether this webhook endpoint is currently active and receiving events.

eventsstring[] required

failing_sincestring nullable required

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.

idstring required

Webhook ID, prefixed hook_.

last_failure_atstring nullable required

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

resource_idstring required

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

testable_eventsstring[] required

urlstring required

Destination URL where webhook payloads are delivered via HTTP POST.

webhook_secretstring nullable required

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; null for API-key and OAuth callers on later reads.

Example response

{
  "api_version": "v1",
  "api_version_date": "2026-01-01",
  "consecutive_failures": 9,
  "created_at": "2026-01-01T12:00:00.000Z",
  "disabled_at": "2026-01-01T12:00:00.000Z",
  "disabled_reason": "delivery_failures",
  "events": [
    "payment.succeeded"
  ],
  "failing_since": "2026-01-01T12:00:00.000Z",
  "id": "hook_xxxxxxxxxxxxxx",
  "last_failure_at": "2026-01-01T12:00:00.000Z",
  "resource_id": "biz_xxxxxxxxxxxxxx",
  "testable_events": [
    "account.updated"
  ],
  "url": "https://example.com/hooks",
  "webhook_secret": "ws_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Changes

Changed in 18 of the 74 revisions of this API.121397

Sep 18, 2026355991ab86d52See the full diff
- ●
  added the new app_payment.requires_action enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new app_payment.requires_action enum value to the / response property for the response status
  response-property-enum-value-added
Sep 17, 2026ef86d14ef6912See the full diff
- ●
  added the new payment.requires_action enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payment.requires_action enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 12, 20261660b8d622042See the full diff
- ●
  added the new financial_activity.funds_available enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new financial_activity.funds_available enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 11, 2026918ff9d965e12See the full diff
- ●
  added the new member.updated enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new member.updated enum value to the / response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 9, 20265fa504e786954See the full diff
- ●
  added the new account.financing_approved enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new account.financing_approved enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new account.financing_denied enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new account.financing_denied enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 8, 20264fe3b2d215464See the full diff
- ●
  added the new ad.updated enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new ad.updated enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new ad_campaign.updated enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new ad_campaign.updated enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 27, 202616c82685be354See the full diff
- ●
  added the new payment.authorized enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payment.authorized enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payment.canceled enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payment.canceled enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 25, 2026621705ee8f4a6See the full diff
- ●
  added the new payout.created enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payout.created enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payout.reversed enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payout.reversed enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payout.updated enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new payout.updated enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 2026f1cf47ad0ec22See the full diff
- ●
  added the new withdrawal.reversed enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new withdrawal.reversed enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 19, 202623dfbe1a0d1f2See the full diff
- ●
  added the new account.updated enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new account.updated enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.

Full history (18 revisions)