From 686fb7fc8ce0e87b4edb2e567042d5941afc6eaa Mon Sep 17 00:00:00 2001 From: Mohammed Islam Date: Sat, 7 Sep 2024 18:48:27 +0200 Subject: [PATCH] docs: mi/webhook-event-types --- .../docs/resources/webhook-event-types.mdx | 26 ++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/packages/documentation/src/content/docs/resources/webhook-event-types.mdx b/packages/documentation/src/content/docs/resources/webhook-event-types.mdx index 4e30cb87c2..4291ef7fa9 100644 --- a/packages/documentation/src/content/docs/resources/webhook-event-types.mdx +++ b/packages/documentation/src/content/docs/resources/webhook-event-types.mdx @@ -2,17 +2,19 @@ title: Webhook event types --- +Webhooks notify you of specific events that occur within your Rafiki instance allowing you to integrate Interledger payments with your system and business processes. For example, Rafiki will notify you when one of your account holders has received an Interledger payment, at which point you would credit their account on your ledger. + The following is an enumeration of all of Rafiki's [webhook event](/integration/requirements/webhook-events) types along with their descriptions, which you must listen to and handle. -| Value | Description | -| --------------------------------- | ---------------------------------------------------------------------------------- | -| `incoming_payment.created` | An incoming payment has been created. | -| `incoming_payment.completed` | An incoming payment is complete and will not accept any additional incoming funds. | -| `incoming_payment.expired` | An incoming payment expired and will not accept any additional incoming funds. | -| `outgoing_payment.created` | An outgoing payment was created. | -| `outgoing_payment.completed` | An outgoing payment completed. | -| `outgoing_payment.failed` | An outgoing payment partially or completely failed. | -| `wallet_address.not_found` | A requested wallet address was not found. | -| `wallet_address.web_monetization` | Web Monetization payments received via STREAM. | -| `asset.liquidity_low` | Asset liquidity has dropped below defined threshold. | -| `peer.liquidity_low` | Peer liquidity has dropped below defined threshold. | +| Value | Description | +| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| [`incoming_payment.created`](/integration/requirements/webhook-events/#incoming-payment-created) | An incoming payment has been created. | +| [`incoming_payment.completed`](/integration/requirements/webhook-events/#incoming-payment-completed) | An incoming payment is complete and will not accept any additional incoming funds. | +| [`incoming_payment.expired`](/integration/requirements/webhook-events/#incoming-payment-expired) | An incoming payment expired and will not accept any additional incoming funds. | +| [`outgoing_payment.created`](/integration/requirements/webhook-events/#outgoing-payment-created) | An outgoing payment was created. | +| [`outgoing_payment.completed`](/integration/requirements/webhook-events/#outgoing-payment-completed) | An outgoing payment completed. | +| [`outgoing_payment.failed`](/integration/requirements/webhook-events/#outgoing-payment-failed) | An outgoing payment partially or completely failed. | +| [`wallet_address.not_found`](/integration/requirements/webhook-events/#wallet-address-not-found) | A requested wallet address was not found. | +| [`wallet_address.web_monetization`](/integration/requirements/webhook-events/#wallet-address-web-monetization) | Web Monetization payments received via STREAM. | +| [`asset.liquidity_low`](/integration/requirements/webhook-events/#asset-liquidity-low) | Asset liquidity has dropped below defined threshold. | +| [`peer.liquidity_low`](/integration/requirements/webhook-events/#peer-liquidity-low) | Peer liquidity has dropped below defined threshold. |