Skip to main content
Cette ressource a un successeur dans l’API Whop, l’API versionnée sur laquelle les nouvelles intégrations doivent s’appuyer. Cette page reste entièrement prise en charge.
ApiVersion
requis
La version de l’API utilisée pour formater les payloads envoyés à cet endpoint de webhook.Options disponibles : v1, v2, v5
string | null
requis
La version datée de l’API (Api-Version-Date) à laquelle sont épinglés les payloads v1 de cet endpoint : les événements sont sérialisés exactement comme une lecture REST à cette version (le sérialiseur natif lorsque la ressource en possède un). Null lorsqu’aucune version n’est épinglée — webhooks legacy (v2/v5) et webhooks v1 utilisant l’ancien format de payload.
boolean
requis
Indique si des événements sont envoyés pour les ressources enfants. Par exemple, si le webhook est rattaché à une entreprise, activer cette option envoie uniquement les événements des sous-marchands de l’entreprise (entreprises enfants).
string<date-time>
requis
La date et l’heure de création du webhook.Exemple : 2023-12-01T05:00:00.401Z
boolean
requis
Indique si cet endpoint de webhook est actuellement actif et reçoit des événements.
array<WebhookEvent>
requis
La liste des types d’événements auxquels ce webhook est abonné.Options disponibles : 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, shipping_address.changed
string
requis
L’identifiant unique du webhook.Exemple : hook_xxxxxxxxxxxxx
string
requis
L’ID de la ressource (entreprise ou produit) à laquelle ce webhook est rattaché.
array<WebhookEvent>
requis
Le sous-ensemble des types d’événements abonnés qui prennent en charge l’envoi de payloads de test.Options disponibles : 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, shipping_address.changed
string
requis
L’URL de destination où les payloads de webhook sont livrés via HTTP POST.Exemple : https://example.com/path
string
requis
La clé secrète utilisée pour signer les payloads de webhook à des fins de vérification. Incluez-la dans votre logique de validation HMAC. Renvoyée dans la réponse de création et aux sessions interactives du tableau de bord ; vide pour les appelants par clé d’API et OAuth lors des lectures ultérieures.Exemple : whsec_abc123def456