List Webhook Events
curl --request GET \
--url https://uat-api.clinkbill.com/api/webhook/events \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>'HttpResponse<String> response = Unirest.get("https://uat-api.clinkbill.com/api/webhook/events")
.header("X-Timestamp", "<x-timestamp>")
.header("X-API-KEY", "<api-key>")
.asString();import requests
url = "https://uat-api.clinkbill.com/api/webhook/events"
headers = {
"X-Timestamp": "<x-timestamp>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Timestamp': '<x-timestamp>', 'X-API-KEY': '<api-key>'}
};
fetch('https://uat-api.clinkbill.com/api/webhook/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"code": 200,
"msg": "Success",
"data": {
"events": [
{
"name": "order.created",
"code": 1,
"description": "Order created"
},
{
"name": "order.succeeded",
"code": 2,
"description": "Order payment succeeded"
},
{
"name": "order.failed",
"code": 3,
"description": "Order payment failed"
},
{
"name": "refund.created",
"code": 4,
"description": "Refund created"
},
{
"name": "refund.succeeded",
"code": 5,
"description": "Refund succeeded"
},
{
"name": "refund.failed",
"code": 6,
"description": "Refund failed"
},
{
"name": "subscription.created",
"code": 7,
"description": "Subscription created"
},
{
"name": "subscription.trialing",
"code": 8,
"description": "Subscription trialing"
},
{
"name": "subscription.activated",
"code": 9,
"description": "Subscription activated"
},
{
"name": "subscription.incomplete_expired",
"code": 10,
"description": "Subscription incomplete expired"
},
{
"name": "subscription.past_due",
"code": 11,
"description": "Subscription past due"
},
{
"name": "subscription.cancelled",
"code": 12,
"description": "Subscription cancelled"
},
{
"name": "invoice.open",
"code": 13,
"description": "Invoice open"
},
{
"name": "invoice.paid",
"code": 14,
"description": "Invoice paid"
},
{
"name": "invoice.void",
"code": 15,
"description": "Invoice void"
},
{
"name": "order.next_action",
"code": 16,
"description": "Order next action required"
},
{
"name": "subscription.updated.plan_changed",
"code": 17,
"description": "Subscription plan changed"
},
{
"name": "subscription.updated.plan_change_canceled",
"code": 18,
"description": "Subscription plan change canceled"
},
{
"name": "subscription.updated.renewed",
"code": 19,
"description": "Subscription renewed"
},
{
"name": "subscription.updated.cancel_at_period_end_set",
"code": 20,
"description": "Subscription cancel at period end set"
},
{
"name": "subscription.updated.cancel_at_period_end_revoked",
"code": 21,
"description": "Subscription cancel at period end revoked"
},
{
"name": "session.complete",
"code": 22,
"description": "Checkout session completed"
},
{
"name": "session.expired",
"code": 23,
"description": "Checkout session expired"
},
{
"name": "dispute.created",
"code": 24,
"description": "Dispute created"
},
{
"name": "dispute.updated",
"code": 25,
"description": "Dispute updated"
},
{
"name": "dispute.won",
"code": 26,
"description": "Dispute won"
},
{
"name": "dispute.lost",
"code": 27,
"description": "Dispute lost"
},
{
"name": "dispute.closed",
"code": 28,
"description": "Dispute closed"
},
{
"name": "customer.verify",
"code": 29,
"description": "Customer verified"
},
{
"name": "payment_method.added",
"code": 30,
"description": "Payment method added"
},
{
"name": "payment_method.default_change",
"code": 31,
"description": "Default payment method changed"
},
{
"name": "risk_rule.updated",
"code": 32,
"description": "Risk rule updated"
},
{
"name": "agent_order.succeeded",
"code": 33,
"description": "Agent order succeeded"
},
{
"name": "agent_order.failed",
"code": 34,
"description": "Agent order failed"
},
{
"name": "agent_refund.succeeded",
"code": 35,
"description": "Agent refund succeeded"
},
{
"name": "agent_refund.failed",
"code": 36,
"description": "Agent refund failed"
},
{
"name": "agent_refund.approved",
"code": 37,
"description": "Agent refund approved"
},
{
"name": "agent_refund.rejected",
"code": 38,
"description": "Agent refund rejected"
},
{
"name": "payment_method.update",
"code": 39,
"description": "Payment method updated"
},
{
"name": "purchase_instruction.created",
"code": 40,
"description": "Purchase instruction created"
},
{
"name": "purchase_instruction.activated",
"code": 41,
"description": "Purchase instruction activated"
},
{
"name": "purchase_instruction.updated",
"code": 42,
"description": "Purchase instruction updated"
},
{
"name": "purchase_instruction.cancelled",
"code": 43,
"description": "Purchase instruction cancelled"
},
{
"name": "vic_device.binding_succeeded",
"code": 44,
"description": "VIC device binding succeeded"
}
],
"aliases": {
"all": [
"order.created",
"order.succeeded",
"order.failed",
"refund.created",
"refund.succeeded",
"refund.failed",
"subscription.created",
"subscription.trialing",
"subscription.activated",
"subscription.incomplete_expired",
"subscription.past_due",
"subscription.cancelled",
"invoice.open",
"invoice.paid",
"invoice.void",
"order.next_action",
"subscription.updated.plan_changed",
"subscription.updated.plan_change_canceled",
"subscription.updated.renewed",
"subscription.updated.cancel_at_period_end_set",
"subscription.updated.cancel_at_period_end_revoked",
"session.complete",
"session.expired",
"dispute.created",
"dispute.updated",
"dispute.won",
"dispute.lost",
"dispute.closed",
"customer.verify",
"payment_method.added",
"payment_method.default_change",
"risk_rule.updated",
"agent_order.succeeded",
"agent_order.failed",
"agent_refund.succeeded",
"agent_refund.failed",
"agent_refund.approved",
"agent_refund.rejected",
"payment_method.update",
"purchase_instruction.created",
"purchase_instruction.activated",
"purchase_instruction.updated",
"purchase_instruction.cancelled",
"vic_device.binding_succeeded"
],
"core": [
"session.complete",
"order.succeeded",
"order.failed",
"refund.succeeded",
"subscription.created",
"invoice.paid"
]
}
}
}{
"code": 123,
"msg": "<string>",
"data": "<unknown>"
}Webhook Endpoint Management
List Webhook Events
Return supported webhook events and event aliases. Use event names in webhook endpoint management requests; numeric event codes are returned for reference only.
GET
/
webhook
/
events
List Webhook Events
curl --request GET \
--url https://uat-api.clinkbill.com/api/webhook/events \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>'HttpResponse<String> response = Unirest.get("https://uat-api.clinkbill.com/api/webhook/events")
.header("X-Timestamp", "<x-timestamp>")
.header("X-API-KEY", "<api-key>")
.asString();import requests
url = "https://uat-api.clinkbill.com/api/webhook/events"
headers = {
"X-Timestamp": "<x-timestamp>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Timestamp': '<x-timestamp>', 'X-API-KEY': '<api-key>'}
};
fetch('https://uat-api.clinkbill.com/api/webhook/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"code": 200,
"msg": "Success",
"data": {
"events": [
{
"name": "order.created",
"code": 1,
"description": "Order created"
},
{
"name": "order.succeeded",
"code": 2,
"description": "Order payment succeeded"
},
{
"name": "order.failed",
"code": 3,
"description": "Order payment failed"
},
{
"name": "refund.created",
"code": 4,
"description": "Refund created"
},
{
"name": "refund.succeeded",
"code": 5,
"description": "Refund succeeded"
},
{
"name": "refund.failed",
"code": 6,
"description": "Refund failed"
},
{
"name": "subscription.created",
"code": 7,
"description": "Subscription created"
},
{
"name": "subscription.trialing",
"code": 8,
"description": "Subscription trialing"
},
{
"name": "subscription.activated",
"code": 9,
"description": "Subscription activated"
},
{
"name": "subscription.incomplete_expired",
"code": 10,
"description": "Subscription incomplete expired"
},
{
"name": "subscription.past_due",
"code": 11,
"description": "Subscription past due"
},
{
"name": "subscription.cancelled",
"code": 12,
"description": "Subscription cancelled"
},
{
"name": "invoice.open",
"code": 13,
"description": "Invoice open"
},
{
"name": "invoice.paid",
"code": 14,
"description": "Invoice paid"
},
{
"name": "invoice.void",
"code": 15,
"description": "Invoice void"
},
{
"name": "order.next_action",
"code": 16,
"description": "Order next action required"
},
{
"name": "subscription.updated.plan_changed",
"code": 17,
"description": "Subscription plan changed"
},
{
"name": "subscription.updated.plan_change_canceled",
"code": 18,
"description": "Subscription plan change canceled"
},
{
"name": "subscription.updated.renewed",
"code": 19,
"description": "Subscription renewed"
},
{
"name": "subscription.updated.cancel_at_period_end_set",
"code": 20,
"description": "Subscription cancel at period end set"
},
{
"name": "subscription.updated.cancel_at_period_end_revoked",
"code": 21,
"description": "Subscription cancel at period end revoked"
},
{
"name": "session.complete",
"code": 22,
"description": "Checkout session completed"
},
{
"name": "session.expired",
"code": 23,
"description": "Checkout session expired"
},
{
"name": "dispute.created",
"code": 24,
"description": "Dispute created"
},
{
"name": "dispute.updated",
"code": 25,
"description": "Dispute updated"
},
{
"name": "dispute.won",
"code": 26,
"description": "Dispute won"
},
{
"name": "dispute.lost",
"code": 27,
"description": "Dispute lost"
},
{
"name": "dispute.closed",
"code": 28,
"description": "Dispute closed"
},
{
"name": "customer.verify",
"code": 29,
"description": "Customer verified"
},
{
"name": "payment_method.added",
"code": 30,
"description": "Payment method added"
},
{
"name": "payment_method.default_change",
"code": 31,
"description": "Default payment method changed"
},
{
"name": "risk_rule.updated",
"code": 32,
"description": "Risk rule updated"
},
{
"name": "agent_order.succeeded",
"code": 33,
"description": "Agent order succeeded"
},
{
"name": "agent_order.failed",
"code": 34,
"description": "Agent order failed"
},
{
"name": "agent_refund.succeeded",
"code": 35,
"description": "Agent refund succeeded"
},
{
"name": "agent_refund.failed",
"code": 36,
"description": "Agent refund failed"
},
{
"name": "agent_refund.approved",
"code": 37,
"description": "Agent refund approved"
},
{
"name": "agent_refund.rejected",
"code": 38,
"description": "Agent refund rejected"
},
{
"name": "payment_method.update",
"code": 39,
"description": "Payment method updated"
},
{
"name": "purchase_instruction.created",
"code": 40,
"description": "Purchase instruction created"
},
{
"name": "purchase_instruction.activated",
"code": 41,
"description": "Purchase instruction activated"
},
{
"name": "purchase_instruction.updated",
"code": 42,
"description": "Purchase instruction updated"
},
{
"name": "purchase_instruction.cancelled",
"code": 43,
"description": "Purchase instruction cancelled"
},
{
"name": "vic_device.binding_succeeded",
"code": 44,
"description": "VIC device binding succeeded"
}
],
"aliases": {
"all": [
"order.created",
"order.succeeded",
"order.failed",
"refund.created",
"refund.succeeded",
"refund.failed",
"subscription.created",
"subscription.trialing",
"subscription.activated",
"subscription.incomplete_expired",
"subscription.past_due",
"subscription.cancelled",
"invoice.open",
"invoice.paid",
"invoice.void",
"order.next_action",
"subscription.updated.plan_changed",
"subscription.updated.plan_change_canceled",
"subscription.updated.renewed",
"subscription.updated.cancel_at_period_end_set",
"subscription.updated.cancel_at_period_end_revoked",
"session.complete",
"session.expired",
"dispute.created",
"dispute.updated",
"dispute.won",
"dispute.lost",
"dispute.closed",
"customer.verify",
"payment_method.added",
"payment_method.default_change",
"risk_rule.updated",
"agent_order.succeeded",
"agent_order.failed",
"agent_refund.succeeded",
"agent_refund.failed",
"agent_refund.approved",
"agent_refund.rejected",
"payment_method.update",
"purchase_instruction.created",
"purchase_instruction.activated",
"purchase_instruction.updated",
"purchase_instruction.cancelled",
"vic_device.binding_succeeded"
],
"core": [
"session.complete",
"order.succeeded",
"order.failed",
"refund.succeeded",
"subscription.created",
"invoice.paid"
]
}
}
}{
"code": 123,
"msg": "<string>",
"data": "<unknown>"
}