Create Webhook
Creates a webhook endpoint that receives event notifications via HTTP POST.
Authorizations
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-07-20"
Body
The URL to send the webhook to.
The API version for this webhook. Defaults to v2.
v1, v2, v5 Whether or not to send events for child resources. For example, if the webhook is created for a company, enabling this will only send events from the company's sub-merchants (child companies).
Whether or not the webhook is enabled. Defaults to true.
The events to send the webhook for, in dot form (for example payment.succeeded).
The company or app to create the webhook for. Defaults to the current company.
Response
webhook created
A webhook endpoint that receives event notifications for a company via HTTP POST.
The API version used to format payloads sent to this webhook endpoint.
v1, v2, v5 Whether events are sent for child resources. For example, if the webhook is on a company, enabling this sends events only from the company's sub-merchants (child companies).
The datetime the webhook was created.
"2023-12-01T05:00:00.401Z"
Whether this webhook endpoint is currently active and receiving events.
The list of event types this webhook is subscribed to.
The different event types available
invoice.created, invoice.marked_uncollectible, invoice.paid, invoice.past_due, invoice.voided, membership.activated, membership.deactivated, membership.trial_ending_soon, entry.created, entry.approved, entry.denied, entry.deleted, setup_intent.requires_action, setup_intent.succeeded, setup_intent.canceled, ledger_account.funds_available, withdrawal.created, withdrawal.updated, course_lesson_interaction.completed, payout_method.created, verification.succeeded, identity_profile.approved, identity_profile.rejected, identity_profile.needs_action, identity_profile.updated, payout_account.status_updated, resolution_center_case.created, resolution_center_case.updated, resolution_center_case.decided, chat.message.created, chat.reaction.created, payment.created, payment.succeeded, payment.failed, payment.pending, dispute.created, dispute.updated, refund.created, refund.updated, dispute_alert.created, membership.cancel_at_period_end_changed The unique identifier for the webhook.
"hook_xxxxxxxxxxxxx"
The ID of the resource (company or product) this webhook is attached to.
The subset of subscribed event types that support sending test payloads.
The different event types available
invoice.created, invoice.marked_uncollectible, invoice.paid, invoice.past_due, invoice.voided, membership.activated, membership.deactivated, membership.trial_ending_soon, entry.created, entry.approved, entry.denied, entry.deleted, setup_intent.requires_action, setup_intent.succeeded, setup_intent.canceled, ledger_account.funds_available, withdrawal.created, withdrawal.updated, course_lesson_interaction.completed, payout_method.created, verification.succeeded, identity_profile.approved, identity_profile.rejected, identity_profile.needs_action, identity_profile.updated, payout_account.status_updated, resolution_center_case.created, resolution_center_case.updated, resolution_center_case.decided, chat.message.created, chat.reaction.created, payment.created, payment.succeeded, payment.failed, payment.pending, dispute.created, dispute.updated, refund.created, refund.updated, dispute_alert.created, membership.cancel_at_period_end_changed The destination URL where webhook payloads are delivered via HTTP POST.
"https://example.com/path"
The secret key used to sign webhook payloads for verification. Include this in your HMAC validation logic. Returned on the create response and to interactive dashboard sessions; empty for API-key and OAuth callers on later reads.
"whsec_abc123def456"

