Skip to main content
Un webhook est rattaché à un compte ou à une app et s’abonne aux événements que vous choisissez. Utilisez l’API Webhooks pour créer et mettre à jour des endpoints, envoyer un événement de test, consulter le journal des livraisons et rejouer les livraisons que votre serveur a manquées. Consultez Webhooks et événements pour vérifier les signatures et gérer les nouvelles tentatives.

Endpoints

Attributs

string
requis
ID du webhook, préfixé par hook_.
string
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 figés les payloads v1 de cet endpoint : les événements sont sérialisés exactement comme une lecture REST à cette version (avec le sérialiseur natif lorsque la ressource en possède un). Null lorsqu’elle n’est pas figée — webhooks legacy (v2/v5), et webhooks v1 utilisant l’ancienne forme de payload.
boolean
requis
Indique si des événements sont envoyés pour les ressources enfants. Par exemple, si le webhook est sur un compte, l’activer envoie uniquement les événements de ses sous-comptes.
integer
requis
Nombre de livraisons consécutives dont la première tentative vers cet endpoint a échoué depuis la dernière livraison acceptée. Les nouvelles tentatives ultérieures de la même livraison ne l’incrémentent pas. Revient à 0 lorsqu’une livraison réussit ou que le webhook est réactivé.
string
requis
Date de création du webhook, sous forme d’horodatage ISO 8601.
string | null
requis
Date à laquelle Whop a automatiquement désactivé ce webhook, sous forme d’horodatage ISO 8601. null sauf si le webhook a été désactivé par Whop ; un webhook que vous avez désactivé vous-même a enabled: false et un disabled_at à null.
string | null
requis
Raison pour laquelle Whop a désactivé ce webhook. delivery_failures signifie que toutes les livraisons ont échoué pendant 3 jours consécutifs. null lorsque disabled_at vaut null.Options disponibles : delivery_failures
boolean
requis
Indique si cet endpoint de webhook est actuellement actif et reçoit des événements.
string[]
requis
Types d’événements auxquels ce webhook est abonné, en notation pointée (par exemple payment.succeeded).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, 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
requis
Date de début de la série d’échecs en cours, sous forme d’horodatage ISO 8601. Contrairement à last_failure_at, elle est définie lors de la première tentative échouée de la série, et indique donc un endpoint en échec en ce moment. null lorsque l’endpoint fonctionne correctement.
string | null
requis
Date du dernier échec d’une livraison vers cet endpoint après épuisement des nouvelles tentatives, sous forme d’horodatage ISO 8601. null si aucune livraison n’a jamais échoué.
string
requis
ID de la ressource (compte ou app) à laquelle ce webhook est rattaché.
string[]
requis
Le sous-ensemble des types d’événements abonnés qui prennent en charge l’envoi de payloads de test, en notation pointée.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, 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
requis
Un libellé pour cet endpoint de webhook, tel que Production, affiché dans le tableau de bord. null si aucun titre n’a été défini.
string
requis
URL de destination où les payloads de webhook sont livrés via HTTP POST.
string | null
requis
Clé secrète utilisée pour signer les payloads de webhook. Utilisez-la pour vérifier la signature HMAC de chaque livraison. Renvoyée dans la réponse de création. null lors des lectures ultérieures par des clés API et des apps OAuth.
Webhook