> ## Documentation Index > Fetch the complete documentation index at: https://docs.clinkbill.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml GET /webhook/events openapi: 3.1.0 info: title: Clink API description: >- Official API documentation for Clink's payment processing platform. This API enables merchants to create and manage payment sessions, handle subscriptions, and process transactions. version: 1.0.0 servers: - url: https://uat-api.clinkbill.com/api/ security: - ApiKeyAuth: [] timestamp: [] paths: /webhook/events: get: summary: List Webhook Events description: >- Return supported webhook events and event aliases. Use event names in webhook endpoint management requests; numeric event codes are returned for reference only. operationId: listWebhookEvents responses: '200': description: Webhook events retrieved successfully content: application/json: schema: $ref: '#/components/schemas/RWebhookEventListResponse' examples: example: value: 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 '*/*': schema: $ref: '#/components/schemas/RWebhookEventListResponse' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ClinkErrorResponse' components: schemas: RWebhookEventListResponse: type: object properties: code: type: integer description: Response status code, 200 when success format: int32 example: 200 msg: type: string description: Brief description of what happened, 'success' when happy case example: Success data: $ref: '#/components/schemas/WebhookEventListResponse' description: Body of the response message ClinkErrorResponse: type: object properties: code: type: integer format: int32 description: Error code returned by Clink. msg: type: string description: Error message. data: description: Additional error data, usually null. WebhookEventListResponse: type: object properties: events: type: array description: Complete list of supported webhook events. items: $ref: '#/components/schemas/WebhookEventResponse' aliases: type: object description: >- Event alias groups. The core alias contains a recommended baseline event set for most payment integrations. properties: all: type: array items: $ref: '#/components/schemas/WebhookEventName' core: type: array items: $ref: '#/components/schemas/WebhookEventName' WebhookEventResponse: type: object properties: name: $ref: '#/components/schemas/WebhookEventName' code: type: integer format: int32 description: >- Internal numeric event code returned for reference only. Numeric event codes are not accepted in public API request bodies. description: type: string description: Human-readable event description. WebhookEventName: type: string description: >- Supported webhook event name. Public API requests use event names, not numeric event codes. enum: - 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 securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: >- Your secret API key obtained from the Clink dashboard (Developers section) timestamp: type: apiKey in: header name: X-Timestamp description: >- Current timestamp in milliseconds since Unix epoch (required for request signing) ````