{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/wallet/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Webhook event reference","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"webhook-event-reference","__idx":0},"children":["Webhook event reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page describes what Ripple Custody (Wallet) sends to your webhook endpoint: the envelope that wraps every delivery, and, for each subscription domain, what triggers an event and what the payload contains. For how to verify, acknowledge, and process deliveries, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/webhooks/receive-webhook-deliveries"},"children":["Receive webhook deliveries"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Domain"},"children":["Domain"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Triggered when"},"children":["Triggered when"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Payload"},"children":["Payload"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TRANSACTION"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A transaction status changes (transfers, deposits, withdrawals)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A wallet status changes (creation, provisioning)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wallet object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVAL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An approval request is created or updated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approval object"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"envelope","__idx":1},"children":["Envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple Custody (Wallet) delivers each webhook message as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," request with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type: application/json"]},". The body is a JSON object with a base64-encoded payload:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["domain"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The subscription domain that the event belongs to: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TRANSACTION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLET"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVAL"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A UTC timestamp for the event, in ISO 8601 format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The resource object, JSON-encoded and then base64-encoded. Decode it to read the resource. Verify the signature against this base64 string before you decode it. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/webhooks/receive-webhook-deliveries#verify-the-signature"},"children":["Verify the signature"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The envelope has no event ID. To detect duplicate deliveries, use the resource's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAt"]}," inside the payload. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/webhooks/receive-webhook-deliveries#deduplicate-deliveries"},"children":["Deduplicate deliveries"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each delivery also carries a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Signature"]}," header that you use to verify that the payload is authentic. For example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEQCIGjBwNKzzfqK9/Rb3Q2OQCyCuUiOOQz7vZwQ9iqInz76AiB/bvRn5iNUAkeVT80/pwhQ2LUajE6Mb2JtGt2mRmJMpg=="]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLET"]}," delivery:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domain\": \"WALLET\",\n    \"timestamp\": \"2025-05-08T14:15:37Z\",\n    \"payload\": \"eyJpZCI6IjAxOTYxNTNiLTY3YmMtN2NkMy1iNTExLTM1NDM3M2QyODEzMCIsICJ2YXVsdElkIjoiMDE5NjE1MmQtNTI5NC03MzlkLTk5NDUtMmE0OTlmOWUzOTg5IiwgIm9yZ2FuaXphdGlvbklkIjoiMjFjODEzMTktNWI4My00NWY5LWI2NDgtNDIwNTUwODRhZjE1IiwgInF1b3J1bUlkIjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIiwgImNyZWF0ZWRCeSI6ImE1NWRmOWUwLWUxNGEtNDQxMC1hOTgzLTEyYWZhZTQ2NjYyZiIsICJjcmVhdGVkQXQiOiIyMDI1LTA0LTA4VDExOjQ4OjU2Ljg5OTA4NloiLCAidXBkYXRlZEF0IjoiMjAyNS0wNC0wOFQxMTo0ODo1Ni45MDA0OTBaIiwgIm5hbWUiOiJld3FmZXciLCAiZGVzY3JpcHRpb24iOiIiLCAiYWRkcmVzcyI6IjB4NDY0NDMyMGYzMUQ2OTU4RWQ4NjAzRWI2NjYwNDQ5NTBBYTY5NzAyZSIsICJwdWJsaWNLZXkiOiIwNDgxY2IwMmU4MjFlNTVhMmM2MTk2ZmZkZTM4MGJhM2I0OTgxN2JkYmYwMmYzMTVkYzI4YjU2ZjcwNzkyZDU2ZTZhZGFjOTE3ZTdhZGFmODdmMTBjMDg4NDA4YThjNmEwZTZkMTgwNzkzYzA1MGMzZDBjODc3MWNiOWRkZjgyNThkIiwgImtleXN0b3JlIjoiSFNNIiwgImJsb2NrY2hhaW4iOiJBUkJJVFJVTSIsICJzZXR0aW5ncyI6e30sICJzdGF0dXMiOiJQUk9WSVNJT05FRCJ9\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Decode ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload"]}," to get the resource object, which contains detailed information about the event. For a decoded wallet object, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#wallet-payload-example"},"children":["Wallet payload example"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transaction-domain","__idx":2},"children":["Transaction domain"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive a webhook notification whenever a transaction transitions to a new status. The payload contains the full transaction object with its current state."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Terminal?"},"children":["Terminal?"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REQUESTED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction created"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POLICY_CHECK_PENDING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validating against policies and collecting any required approvals"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POLICY_CHECK_PASSED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Policy checks and all required approvals passed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPILATION_PENDING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Preparing for blockchain"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ready for signing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SIGNATURE_PENDING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Waiting for signature"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SIGNED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Signed successfully"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUBLISH_PENDING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submitting to network"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUBLISHED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submitted to blockchain"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONFIRMATION_PENDING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Awaiting block confirmation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONFIRMED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirmed on blockchain"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rejected by policy or approval"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Technical failure"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more details on transaction status flow, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/transactions"},"children":["How transactions work"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"transaction-payload-example","__idx":3},"children":["Transaction payload example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"domain\": \"TRANSACTION\",\n  \"timestamp\": \"2025-05-08T14:30:00Z\",\n  \"payload\": \"base64-encoded-transaction-object\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When decoded, the payload contains the transaction object. Key fields include:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"019c94f1-cc8c-79b4-9c0f-bc7edaabc267\",\n  \"vaultId\": \"0196152d-5294-739d-9945-2a499f9e3989\",\n  \"walletId\": \"0196153b-67bc-7cd3-b511-354373d28130\",\n  \"organizationId\": \"21c81319-5b83-45f9-b648-42055084af15\",\n  \"status\": \"CONFIRMED\",\n  \"blockchain\": \"ETHEREUM\",\n  \"hash\": \"0x8a4c5e9f2b1d7c3a6e8f0b2d4c6a8e0f2b4d6c8a0e2f4b6d8c0a2e4f6b8d0c2e\",\n  \"destination\": {\n    \"address\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f2E8Ba\"\n  },\n  \"asset\": {\n    \"symbol\": \"ETH\"\n  },\n  \"qty\": \"1.500000000000000000\",\n  \"createdAt\": \"2025-05-08T14:25:00Z\",\n  \"updatedAt\": \"2025-05-08T14:30:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the complete transaction schema, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_gettransaction"},"children":["Transaction API reference"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Inbound transactions and compliance"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For inbound transactions, the payload may include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["freezeInfo"]}," field indicating whether funds are frozen for compliance review. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/changelogs/transaction-freeze-and-compliance-controls"},"children":["Transaction Freeze and Compliance Controls"]}," for details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"wallet-domain","__idx":4},"children":["Wallet domain"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive a webhook notification whenever a wallet transitions to a new status. The payload contains the full wallet object with its current state."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Terminal?"},"children":["Terminal?"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CREATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wallet record created"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROVISIONING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wallet being set up"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROVISIONED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wallet ready for use"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROVISIONING_FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Setup failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"wallet-payload-example","__idx":5},"children":["Wallet payload example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The envelope's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["domain"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLET"]},"; see the example in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#envelope"},"children":["Envelope"]},". When decoded, the payload contains the wallet object. For example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"0196153b-67bc-7cd3-b511-354373d28130\",\n  \"vaultId\": \"0196152d-5294-739d-9945-2a499f9e3989\",\n  \"organizationId\": \"21c81319-5b83-45f9-b648-42055084af15\",\n  \"createdBy\": \"a55df9e0-e14a-4410-a983-12afae46662f\",\n  \"createdAt\": \"2025-04-08T11:48:56.899086Z\",\n  \"updatedAt\": \"2025-04-08T11:48:56.900490Z\",\n  \"name\": \"My Wallet\",\n  \"address\": \"0x4644320f31D6958Ed8603Eb666044950Aa69702e\",\n  \"publicKey\": \"0481cb02e821e55a2c6196ffde380ba3b49817bdbf02f315dc28b56f70792d56e6adac917e7adaf87f10c088408a8c6a0e6d180793c050c3d0c8771cb9ddf8258d\",\n  \"keystore\": \"HSM\",\n  \"blockchain\": \"ARBITRUM\",\n  \"settings\": {},\n  \"status\": \"PROVISIONED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the complete wallet schema, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_getwallet"},"children":["Wallet API reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"approval-domain","__idx":6},"children":["Approval domain"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive a webhook notification whenever an approval request is created or updated. This includes approvals for transactions, policy changes, and user management actions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payload contains the approval request with its current state: the overall status of the approval set, and the status of each approver's response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"approval-set-status","__idx":7},"children":["Approval set status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The overall approval request status:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Terminal?"},"children":["Terminal?"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Waiting for approvers to respond"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required approvals received"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT_MET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approval rejected"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EXPIRED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timed out before requirements met"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Technical failure during processing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"individual-approval-status","__idx":8},"children":["Individual approval status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each approver's response within an approval set:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROCESSING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approver is reviewing the request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approver approved the request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approver rejected the request"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":9},"children":["Related topics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/webhooks"},"children":["Webhooks"]}," — What webhooks are, how delivery works, and webhooks compared with audit logging"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/webhooks/receive-webhook-deliveries"},"children":["Receive webhook deliveries"]}," — Verify signatures, handle retries, and process events safely"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/webhooks/manage-webhooks-api"},"children":["Manage webhooks via the API"]}," — Subscribe a webhook to domains"]}]}]},"headings":[{"value":"Webhook event reference","id":"webhook-event-reference","depth":1},{"value":"Envelope","id":"envelope","depth":2},{"value":"Transaction domain","id":"transaction-domain","depth":2},{"value":"Transaction payload example","id":"transaction-payload-example","depth":3},{"value":"Wallet domain","id":"wallet-domain","depth":2},{"value":"Wallet payload example","id":"wallet-payload-example","depth":3},{"value":"Approval domain","id":"approval-domain","depth":2},{"value":"Approval set status","id":"approval-set-status","depth":3},{"value":"Individual approval status","id":"individual-approval-status","depth":3},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"title":"Webhook event reference","seo":{"title":"Webhook event reference"}},"lastModified":"2026-10-09T11:28:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/wallet/integrations-and-monitoring/webhooks/webhook-event-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}