Skip to content

Commit

Permalink
docs: mi/webhook-event-types
Browse files Browse the repository at this point in the history
  • Loading branch information
@hajjimo
hajjimo committed Sep 7, 2024
1 parent feb1f82 commit 686fb7f
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions packages/documentation/src/content/docs/resources/webhook-event-types.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

0 comments on commit 686fb7f

Please sign in to comment.