Introduction
Payins
Payouts
Identity
CRM
Engagement
Courses
Developer
AI
Stats
{
"id": "hook_xxxxxxxxxxxxx",
"url": "https://example.com/path",
"enabled": true,
"events": [
"invoice.created"
],
"api_version": "v1",
"created_at": "2023-12-01T05:00:00.401Z",
"child_resource_events": true,
"testable_events": [
"invoice.created"
],
"resource_id": "<string>"
}Webhook
A webhook endpoint that receives event notifications for a company via HTTP POST.
The unique identifier for the webhook.
"hook_xxxxxxxxxxxxx"
The destination URL where webhook payloads are delivered via HTTP POST.
"https://example.com/path"
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.paid, invoice.past_due, invoice.voided, membership.activated, membership.deactivated, entry.created, entry.approved, entry.denied, entry.deleted, setup_intent.requires_action, setup_intent.succeeded, setup_intent.canceled, withdrawal.created, withdrawal.updated, course_lesson_interaction.completed, payout_method.created, verification.succeeded, payout_account.status_updated, 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 API version used to format payloads sent to this webhook endpoint.
v1, v2, v5 The datetime the webhook was created.
"2023-12-01T05:00:00.401Z"
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 subset of subscribed event types that support sending test payloads.
The different event types available
invoice.created, invoice.paid, invoice.past_due, invoice.voided, membership.activated, membership.deactivated, entry.created, entry.approved, entry.denied, entry.deleted, setup_intent.requires_action, setup_intent.succeeded, setup_intent.canceled, withdrawal.created, withdrawal.updated, course_lesson_interaction.completed, payout_method.created, verification.succeeded, payout_account.status_updated, 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 ID of the resource (company or product) this webhook is attached to.
Was this page helpful?