Skip to main content
En webhook er knyttet til en konto eller en app og abonnerer på de hændelser, du vælger. Brug Webhooks API’et til at oprette og opdatere endpoints, sende en testhændelse, inspicere leveringsloggen og afspille leveringer igen, som din server gik glip af. Se Webhooks og hændelser for at verificere signaturer og håndtere genforsøg.

Endpoints

Attributter

string
påkrævet
Webhook-ID med præfikset hook_.
string
påkrævet
Den API-version, der bruges til at formatere payloads sendt til dette webhook-endpoint.Tilgængelige muligheder: v1, v2, v5
string | null
påkrævet
Den daterede API-version (Api-Version-Date), som v1-payloads for dette endpoint er fastlåst til: hændelser serialiseres præcis som en REST-læsning i denne version (den native serializer, hvor ressourcen har en). Null, når den ikke er fastlåst — legacy- (v2/v5) webhooks og v1-webhooks med den gamle payload-form.
boolean
påkrævet
Om der sendes hændelser for underordnede ressourcer. Hvis webhooken for eksempel er på en konto, sender aktivering af dette kun hændelser fra dens underkonti.
integer
påkrævet
Antal på hinanden følgende leveringer, hvis første forsøg til dette endpoint mislykkedes, siden det sidst accepterede en. Senere genforsøg af den samme levering øger det ikke. Nulstilles til 0, når en levering lykkes, eller webhooken genaktiveres.
string
påkrævet
Hvornår webhooken blev oprettet, som et ISO 8601-tidsstempel.
string | null
påkrævet
Hvornår Whop automatisk deaktiverede denne webhook, som et ISO 8601-tidsstempel. null, medmindre webhooken blev deaktiveret af Whop; en webhook, du selv har deaktiveret, har enabled: false og en null disabled_at.
string | null
påkrævet
Hvorfor Whop deaktiverede denne webhook. delivery_failures betyder, at alle leveringer mislykkedes i 3 dage i træk. null, når disabled_at er null.Tilgængelige muligheder: delivery_failures
boolean
påkrævet
Om dette webhook-endpoint i øjeblikket er aktivt og modtager hændelser.
string[]
påkrævet
Hændelsestyper, som denne webhook abonnerer på, i punktform (for eksempel 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
string | null
påkrævet
Hvornår den aktuelle fejlserie begyndte, som et ISO 8601-tidsstempel. I modsætning til last_failure_at angives dette ved seriens første mislykkede forsøg, så det viser et endpoint, der fejler lige nu. null, når endpointet er sundt.
string | null
påkrævet
Hvornår en levering til dette endpoint senest mislykkedes efter at have opbrugt genforsøg, som et ISO 8601-tidsstempel. null, hvis ingen levering nogensinde er mislykkedes.
string
påkrævet
ID for den ressource (konto eller app), som denne webhook er knyttet til.
string[]
påkrævet
Den delmængde af abonnerede hændelsestyper, der understøtter afsendelse af test-payloads, i punktform.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
string | null
påkrævet
En etiket for dette webhook-endpoint, såsom Production, der vises i dashboardet. null, hvis ingen titel er angivet.
string
påkrævet
Destinations-URL, hvor webhook-payloads leveres via HTTP POST.
string | null
påkrævet
Hemmelig nøgle, der bruges til at signere webhook-payloads. Brug den til at verificere HMAC-signaturen for hver levering. Returneres i create-svaret. null ved senere læsninger af API-nøgler og OAuth-apps.
Webhook