Skip to main content
Een webhook is gekoppeld aan een account of een app en abonneert zich op de events die je kiest. Gebruik de Webhooks API om endpoints aan te maken en bij te werken, een test-event te verzenden, het afleveringslogboek te bekijken en afleveringen opnieuw af te spelen die je server heeft gemist. Zie Webhooks & Events voor het verifiëren van handtekeningen en het afhandelen van nieuwe pogingen.

Endpoints

Attributen

string
vereist
Webhook-ID, met prefix hook_.
string
vereist
De API-versie die wordt gebruikt om payloads op te maken die naar dit webhook-endpoint worden verzonden.Beschikbare opties: v1, v2, v5
string | null
vereist
De gedateerde API-versie (Api-Version-Date) waaraan v1-payloads voor dit endpoint zijn vastgezet: events worden precies geserialiseerd zoals een REST-read in deze versie (de native serializer waar de resource er een heeft). Null wanneer niet vastgezet — legacy (v2/v5) webhooks, en v1-webhooks met de legacy payloadvorm.
boolean
vereist
Of er events worden verzonden voor onderliggende resources. Als de webhook bijvoorbeeld op een account staat, worden met deze instelling alleen events van de subaccounts verzonden.
integer
vereist
Aantal opeenvolgende afleveringen waarvan de eerste poging naar dit endpoint is mislukt sinds het er voor het laatst een accepteerde. Latere nieuwe pogingen van dezelfde aflevering verhogen dit niet. Wordt teruggezet naar 0 wanneer een aflevering slaagt of de webhook opnieuw wordt ingeschakeld.
string
vereist
Wanneer de webhook is aangemaakt, als ISO 8601-tijdstempel.
string | null
vereist
Wanneer Whop deze webhook automatisch heeft uitgeschakeld, als ISO 8601-tijdstempel. null tenzij de webhook door Whop is uitgeschakeld; een webhook die je zelf hebt uitgeschakeld heeft enabled: false en een disabled_at van null.
string | null
vereist
Waarom Whop deze webhook heeft uitgeschakeld. delivery_failures betekent dat elke aflevering 3 dagen achter elkaar is mislukt. null wanneer disabled_at null is.Beschikbare opties: delivery_failures
boolean
vereist
Of dit webhook-endpoint momenteel actief is en events ontvangt.
string[]
vereist
Eventtypes waarop deze webhook is geabonneerd, in puntnotatie (bijvoorbeeld 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
string | null
vereist
Wanneer de huidige reeks mislukkingen begon, als ISO 8601-tijdstempel. In tegenstelling tot last_failure_at wordt dit ingesteld bij de eerste mislukte poging van de reeks, zodat het een endpoint toont dat op dit moment faalt. null wanneer het endpoint gezond is.
string | null
vereist
Wanneer een aflevering naar dit endpoint voor het laatst is mislukt nadat alle nieuwe pogingen waren uitgeput, als ISO 8601-tijdstempel. null als er nog nooit een aflevering is mislukt.
string
vereist
ID van de resource (account of app) waaraan deze webhook is gekoppeld.
string[]
vereist
De subset van geabonneerde eventtypes die het verzenden van testpayloads ondersteunen, in puntnotatie.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
string | null
vereist
Een label voor dit webhook-endpoint, zoals Production, dat in het dashboard wordt getoond. null als er geen titel is ingesteld.
string
vereist
Bestemmings-URL waarnaar webhook-payloads via HTTP POST worden afgeleverd.
string | null
vereist
Geheime sleutel die wordt gebruikt om webhook-payloads te ondertekenen. Gebruik deze om de HMAC-handtekening van elke aflevering te verifiëren. Wordt geretourneerd in de create-respons. null bij latere reads door API-sleutels en OAuth-apps.
Webhook