Skip to main content
Este recurso tiene un sucesor en la API de Whop, la API versionada sobre la que deben construirse las nuevas integraciones. Esta página sigue teniendo soporte completo.
ApiVersion
requerido
La versión de la API utilizada para dar formato a los payloads enviados a este endpoint de webhook.Opciones disponibles: v1, v2, v5
string | null
requerido
La versión fechada de la API (Api-Version-Date) a la que están fijados los payloads v1 de este endpoint: los eventos se serializan exactamente igual que una lectura REST en esta versión (con el serializador nativo cuando el recurso tiene uno). Null cuando no está fijada: webhooks heredados (v2/v5) y webhooks v1 con la forma de payload heredada.
boolean
requerido
Si se envían eventos de los recursos secundarios. Por ejemplo, si el webhook está en una empresa, habilitar esta opción envía solo eventos de los subcomerciantes de la empresa (empresas secundarias).
string<date-time>
requerido
La fecha y hora en que se creó el webhook.Ejemplo: 2023-12-01T05:00:00.401Z
boolean
requerido
Si este endpoint de webhook está activo actualmente y recibiendo eventos.
array<WebhookEvent>
requerido
La lista de tipos de eventos a los que está suscrito este webhook.Opciones 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
requerido
El identificador único del webhook.Ejemplo: hook_xxxxxxxxxxxxx
string
requerido
El ID del recurso (empresa o producto) al que está asociado este webhook.
array<WebhookEvent>
requerido
El subconjunto de tipos de eventos suscritos que admiten el envío de payloads de prueba.Opciones 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
requerido
La URL de destino donde se entregan los payloads del webhook mediante HTTP POST.Ejemplo: https://example.com/path
string
requerido
La clave secreta utilizada para firmar los payloads del webhook para su verificación. Inclúyela en tu lógica de validación HMAC. Se devuelve en la respuesta de creación y en las sesiones interactivas del panel; vacía para los llamadores con clave de API y OAuth en lecturas posteriores.Ejemplo: whsec_abc123def456