Skip to main content
웹훅은 계정 또는 앱에 연결되며 선택한 이벤트를 구독합니다. Webhooks API를 사용하여 엔드포인트를 생성 및 업데이트하고, 테스트 이벤트를 보내고, 전송 로그를 확인하고, 서버가 놓친 전송을 재전송하세요. 서명 검증과 재시도 처리는 웹훅 및 이벤트를 참조하세요.

엔드포인트

속성

string
필수
웹훅 ID이며, 접두사는 hook_입니다.
string
필수
이 웹훅 엔드포인트로 전송되는 페이로드의 형식을 지정하는 데 사용되는 API 버전입니다.사용 가능한 옵션: v1, v2, v5
string | null
필수
이 엔드포인트의 v1 페이로드가 고정된 날짜 기반 API 버전(Api-Version-Date)입니다. 이벤트는 이 버전에서의 REST 읽기와 정확히 동일하게 직렬화됩니다(리소스에 네이티브 직렬화기가 있는 경우 해당 직렬화기 사용). 고정되지 않은 경우 Null입니다. 레거시(v2/v5) 웹훅 및 레거시 페이로드 형태의 v1 웹훅이 이에 해당합니다.
boolean
필수
하위 리소스에 대한 이벤트를 보낼지 여부. 예를 들어 웹훅이 계정에 있는 경우, 이 옵션을 활성화하면 하위 계정의 이벤트만 보냅니다.
integer
필수
이 엔드포인트가 마지막으로 전송을 수락한 이후 첫 시도가 실패한 연속 전송 횟수. 같은 전송의 이후 재시도는 이 값을 증가시키지 않습니다. 전송이 성공하거나 웹훅이 다시 활성화되면 0으로 초기화됩니다.
string
필수
웹훅이 생성된 시점(ISO 8601 타임스탬프).
string | null
필수
Whop이 이 웹훅을 자동으로 비활성화한 시점(ISO 8601 타임스탬프). Whop이 웹훅을 비활성화한 경우가 아니면 null이며, 직접 비활성화한 웹훅은 enabled: false이고 disabled_at이 null입니다.
string | null
필수
Whop이 이 웹훅을 비활성화한 이유. delivery_failures는 3일 연속 모든 전송이 실패했음을 의미합니다. disabled_at이 null이면 null입니다.사용 가능한 옵션: delivery_failures
boolean
필수
이 웹훅 엔드포인트가 현재 활성 상태이며 이벤트를 수신하고 있는지 여부입니다.
string[]
필수
이 웹훅이 구독하는 이벤트 유형으로, 점 표기법을 사용합니다(예: payment.succeeded).사용 가능한 옵션: 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
필수
현재 연속 실패가 시작된 시점(ISO 8601 타임스탬프). last_failure_at과 달리 연속 실패의 첫 실패 시도에서 설정되므로, 현재 실패 중인 엔드포인트를 보여줍니다. 엔드포인트가 정상이면 null입니다.
string | null
필수
이 엔드포인트로의 전송이 재시도를 모두 소진한 후 가장 최근에 실패한 시점(ISO 8601 타임스탬프). 전송이 실패한 적이 없으면 null입니다.
string
필수
이 웹훅이 연결된 리소스(계정 또는 앱)의 ID.
string[]
필수
구독한 이벤트 유형 중 테스트 페이로드 전송을 지원하는 하위 집합으로, 점 표기법을 사용합니다.사용 가능한 옵션: 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
필수
대시보드에 표시되는 Production과 같은 이 웹훅 엔드포인트의 레이블. 이름이 설정되지 않은 경우 null입니다.
string
필수
웹훅 페이로드가 HTTP POST로 전송되는 대상 URL.
string | null
필수
웹훅 페이로드에 서명하는 데 사용되는 시크릿 키. 각 전송의 HMAC 서명을 검증하는 데 사용하세요. 생성 응답에서 반환됩니다. 이후 API 키와 OAuth 앱으로 조회하면 null입니다.
Webhook