This document lists all subscribable Webhook events currently supported by GStable. You can choose to subscribe to specific event types when creating a Webhook based on your business needs.
Payload Data Structure
As described in Verification & Handling, the payload field of all events contains the resource object where the change occurred.
To simplify development, the data structure in Payload is consistent with the response structure of the corresponding resource's API query interface:
- Session Events (
session.*): payload.sessionData corresponds to response data of Query Payment Session.
- Payment Link Events (
payment.link.*): payload.linkData corresponds to response data of Query Payment Link.
- Product Events (
product.*): payload.productData corresponds to response data of Query Product.
- Account Events (
account.*): payload.accountData corresponds to response data of Query Account.
Supported Events List
Account Events
| Event Type | Description |
|---|
account.created | The account has been created. |
account.updated | The account has been updated. |
account.removed | The account has been removed, and the account is no longer available for payment. |
PaymentLink Events
| Event Type | Description |
|---|
payment.link.created | The payment link has been created. |
payment.link.updated | The payment link has been updated. |
payment.link.disabled | The payment link has been disabled. The link is no longer available for payment. |
payment.link.enabled | The payment link has been enabled. The link is now available for payment. |
Product Events
| Event Type | Description |
|---|
product.created | The product has been created. |
product.updated | The product has been updated. |
product.unarchived | The product has been unarchived. The product is now available for payment. |
product.archived | The product has been archived. The product is no longer available for payment. |
product.removed | The product has been removed. The product is no longer available for payment. |
Session Events
| Event Type | Description |
|---|
session.created | The session has been created and is awaiting payment. |
session.paid | The user has successfully paid onchain and is awaiting settlement. Can be considered as payment completed, but not settled completed. |
session.settling | The payment has been confirmed and is being settled. Only for cross-chain payments. Typically occurs after payment success. |
session.completed | The session has been completed and the payment is settled. The funds have been received by the recipient. |
session.expired | The session has expired and the payment is not settled. The session is no longer available for payment. |
session.cancelled | The session has been cancelled and the payment is not settled. The session is no longer available for payment. |
session.settlement.pending | Settlement is temporarily delayed. The system is automatically retrying, and no action is required. Settlement will be completed. |