{"templateId":"markdown","versions":[{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/reference/events-and-webhooks/event-payload-reference","default":true,"active":true,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/reference/events-and-webhooks/event-payload-reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/reference/events-and-webhooks/event-payload-reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/reference/events-and-webhooks/event-payload-reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/reference/events-and-webhooks/event-payload-reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/reference/events-and-webhooks/event-payload-reference","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","tabs","tab"]},"type":"markdown"},"seo":{"title":"Event payload 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":"event-payload-reference","__idx":0},"children":["Event payload reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can track and respond to events in ","Ripple Custody"," domains using one of the following methods:"]},{"$$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":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$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":"strong","attributes":{},"children":["Events API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pull"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query events on-demand using the API. Available out of the box."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Push"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Receive real-time HTTP callbacks when events occur. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/events-and-webhooks/webhooks-ui"},"children":["Webhooks (UI)"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/events-and-webhooks/webhooks-api"},"children":["Webhooks (API)"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AMQP queue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Push"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consume events through an Advanced Message Queuing Protocol (AMQP) compatible message queue. Requires Ripple setup."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Events do not provide a detailed description of a state change, but are a starting point for requesting further information from the API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information about querying events with the API, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/reference/api/openapi/events/getevents"},"children":["Events"]}," in the API reference."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can pull events with the API out of the box."," ","For webhook setup, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/events-and-webhooks/webhooks-ui"},"children":["Webhooks (UI)"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/events-and-webhooks/webhooks-api"},"children":["Webhooks (API)"]},"."," ","For AMQP queue setup, contact ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/support/get-support"},"children":["Ripple support"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The different event types available are described below."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"genesis-event","__idx":1},"children":["Genesis event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The genesis event is triggered upon successful completion of the system setup genesis operation. The event contains the following important public keys:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiPublicKey"]},": to be used to validate the data integrity at the API level."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["messagingPublicKey"]},": to be used by vaults to authenticate transaction processing requests."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payload also includes the following blocks:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdEntitiesReferences"]},": a list of all entities created"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["genesis"]},": the full genesis payload, execution time, and signature"]}]},{"$$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":"Event type"},"children":["Event type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event trigger"},"children":["Event trigger"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fields in the payload"},"children":["Fields in the 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":["GenesisSucceeded"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Successful completion of genesis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiPublicKey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["messagingPublicKey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"apiPublicKey\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAET1BnSIvToEO6r5BMmaG+O3GL0/A7JilzCdmJ3trIWIsXDuv8jAcGizraMouqWIHTx2hi3rxoH7eABURbfSSryw==\",\n        \"messagingPublicKey\": \"MCowBQYDK2VwAyEAUGkt+kcvAT4vh+XSEL5Azv4XjjN4e+RojV2gr+Bu0Uk=\",\n        \"type\": \"GenesisSucceeded\",\n        \"createdEntitiesReferences\": {\n          \"domains\": [\n            {\n              \"id\": \"70fe2431-0c7e-4251-aa69-8c960a4303b5\",\n              \"parentDomainId\": null | \"27aef9d4-c41f-496b-a84b-89a0982f230d\"\n            }\n          ],\n          \"users\": [\n            {\n              \"domainId\": \"70fe2431-0c7e-4251-aa69-8c960a4303b5\",\n              \"id\": \"b9e2a9ca-2eb5-4cc3-98b1-0e9d3ec09129\"\n            }\n          ],\n          \"policies\": [\n            {\n              \"domainId\": \"70fe2431-0c7e-4251-aa69-8c960a4303b5\",\n              \"id\": \"8e7a40d3-b255-4a0a-8b80-13596bf566ae\"\n            }\n          ],\n          \"tickers\": [\n            {\n              \"id\": \"def26868-39e0-4ad3-8f02-22d388409544\"\n            }\n          ],\n          \"systemProperties\": [\n            {\n              \"id\": \"STATE_REVIEW_AUTHORITY\"\n            }\n          ]\n        },\n        \"genesis\": null | {\n          \"data\": {\n            \"executedAt\": \"2019-08-24T14:15:10Z\",\n            \"payload\": {\n              \"rootDomainSetup\": {\n              },\n              \"cryptoSetup\": {\n              },\n              \"tickers\": [\n              ],\n              \"systemProperties\": [\n              ]\n            }\n          },\n          \"signature\": \"<SIGNATURE>\",\n        }\n      },\n    },\n    \"id\": \"d1553d40-fbd9-3e44-ac7b-8cd59fa20c77\",\n    \"sequenceNumber\": 1,\n    \"savedAt\": \"2021-11-26T12:16:23.027Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"intent-events","__idx":2},"children":["Intent events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The creation, update (due to an approval or rejection), execution, or closure (after final decision or expiry) of an intent triggers a corresponding event. The event exposes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of the intent, which you can retrieve independently to view more details of the intent."]},{"$$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":"Event type"},"children":["Event type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event trigger"},"children":["Event trigger"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fields in the payload"},"children":["Fields in the 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":["IntentCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of an intent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IntentUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of an intent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IntentExecuted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Execution of an approved intent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IntentClosed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Closure of an approved, rejected, or failed intent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload examples:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"IntentCreated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"6a9a5cc0-3536-46e2-b9b5-7533ee25a0eb\",\n        \"type\": \"IntentCreated\"\n    },\n    \"id\": \"117d8e91-7dd8-3e5d-8e5e-1d11ac57e148\",\n    \"sequenceNumber\": 1989,\n    \"savedAt\": \"2022-01-10T17:27:09.902Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"IntentUpdated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"6a9a5cc0-3536-46e2-b9b5-7533ee25a0eb\",\n        \"type\": \"IntentUpdated\"\n    },\n    \"id\": \"067d411c-ef2a-347a-adc6-67d9e2156750\",\n    \"sequenceNumber\": 1990,\n    \"savedAt\": \"2022-01-10T17:27:09.934Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"IntentExecuted","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"6a9a5cc0-3536-46e2-b9b5-7533ee25a0eb\",\n        \"type\": \"IntentExecuted\"\n    },\n    \"id\": \"b4390a9c-5011-3977-9456-4218224e4801\",\n    \"sequenceNumber\": 1991,\n    \"savedAt\": \"2022-01-10T17:27:09.934Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"IntentClosed","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"6a9a5cc0-3536-46e2-b9b5-7533ee25a0eb\",\n        \"type\": \"IntentClosed\"\n    },\n    \"id\": \"817459ba-bd2b-355e-ab7e-699c53e21af8\",\n    \"sequenceNumber\": 1992,\n    \"savedAt\": \"2022-01-10T17:27:09.934Z\"\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following events typically follow an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IntentClosed"]}," event, as the creation or update of an entity often follows intent closure."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some entities, such as an account, transaction, or vault, need special processing steps after creation until they are fully operational. An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Updated"]}," type event is triggered upon full creation of the entity."]},{"$$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":"Event type"},"children":["Event type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event trigger"},"children":["Event trigger"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fields in the payload"},"children":["Fields in the 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":["AccountCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AddressCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of an address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BalancesUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of an account's balances"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tickerIds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DomainCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of a domain"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentId"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DomainUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of a domain"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EndpointCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of a endpoint"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EndpointUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of an endpoint"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ManifestCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of a manifest"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ManifestUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manifest signed by the vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PolicyCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of a policy"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PolicyUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of a policy"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransferUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quarantine of a transfer released"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UserCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of a user"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UserUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of a user"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VaultCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VaultUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payload format is the same for all of these events except ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ManifestCreated"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ManifestUpdated"]},", which contain an additional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}," field."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload examples:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"AccountCreated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"f0048a50-3988-4e31-9cbf-c4b6582d338d\",\n        \"type\": \"AccountCreated\"\n    },\n    \"id\": \"f2803e98-2980-3324-9c69-430dfc88b8bc\",\n    \"sequenceNumber\": 190,\n    \"savedAt\": \"2021-12-03T11:36:06.834Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"AccountUpdated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"f0048a50-3988-4e31-9cbf-c4b6582d338d\",\n        \"type\": \"AccountUpdated\"\n    },\n    \"id\": \"608fdbcd-c614-3f96-b0f9-c1580a81084a\",\n    \"sequenceNumber\": 191,\n    \"savedAt\": \"2021-12-03T11:36:07.271Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"ManifestCreated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"d6554f85-d7ac-45b9-8f36-648f56ea5c3b\",\n    \"payload\": {\n        \"id\": \"6b11452c-1851-42ae-8d86-6cb8cea4fbc5\",\n        \"accountId\": \"237295f6-bcca-4429-a1ff-48a12e58af31\",\n        \"type\": \"ManifestCreated\"\n    },\n    \"id\": \"1f214b96-4b5a-3d93-8284-534ec722d6b7\",\n    \"sequenceNumber\": 594752,\n    \"savedAt\": \"2024-10-24T10:41:42.782Z\"\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transaction-events","__idx":3},"children":["Transaction events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The creation of a transaction, its first detection on the blockchain (that is, an outgoing transaction is broadcast, or an incoming transaction is captured), and any change of status (such as confirmation status) triggers a corresponding event. The event exposes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of the transaction as well as the references to the accounts that are related to the transaction."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A single transaction may impact multiple accounts at once, for example if a Bitcoin transaction with multiple outputs targets more than one ","Ripple Custody"," account."]}]},{"$$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":"Event type"},"children":["Event type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event trigger"},"children":["Event trigger"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fields in the payload"},"children":["Fields in the 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":["TransactionCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation of a transaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReferences"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionDetected"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detection of a transaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReferences"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update of a transaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReferences"]},",",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload examples:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TransactionCreated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"77cd7e83-f884-46cc-a557-997cae558fb9\",\n        \"senderReferences\": [\n            {\n                \"id\": \"632d9607-f523-446c-99a3-ad78fdd438e2\",\n                \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\"\n            }\n        ],\n        \"type\": \"TransactionCreated\"\n    },\n    \"id\": \"6422fdfa-558c-346f-9a2e-da6f45210ece\",\n    \"sequenceNumber\": 692,\n    \"savedAt\": \"2021-12-14T16:59:53.521Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TransactionDetected","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"852a2495-17b4-4b92-8ef7-4e823302ee83\",\n        \"accountReferences\": [\n            {\n                \"id\": \"f0048a50-3988-4e31-9cbf-c4b6582d338d\",\n                \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\"\n            }\n        ],\n        \"type\": \"TransactionDetected\"\n    },\n    \"id\": \"3ab29804-6a8b-38e5-97c5-f513244a2bad\",\n    \"sequenceNumber\": 686,\n    \"savedAt\": \"2021-12-14T14:15:27.821Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TransactionUpdated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\",\n    \"payload\": {\n        \"id\": \"852a2495-17b4-4b92-8ef7-4e823302ee83\",\n        \"accountReferences\": [\n            {\n                \"id\": \"f0048a50-3988-4e31-9cbf-c4b6582d338d\",\n                \"domainId\": \"5cd224fe-193e-8bce-c94c-c6c05245e2d1\"\n            }\n        ],\n        \"type\": \"TransactionUpdated\"\n    },\n    \"id\": \"b4390a9c-5011-3977-9456-4218224e4801\",\n    \"sequenceNumber\": 687,\n    \"savedAt\": \"2021-12-14T14:18:12.493Z\"\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"compliance-events","__idx":4},"children":["Compliance events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The system triggers compliance-related events when compliance configuration changes or when a transfer skips quarantine. These events provide audit visibility into compliance decisions."]},{"$$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":"Event type"},"children":["Event type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event trigger"},"children":["Event trigger"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fields in the payload"},"children":["Fields in the 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":["ComplianceConfigurationUpdated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account compliance configuration changed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReference"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipQuarantineFrom"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revision"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedBy"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QuarantineSkipped"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal transfer skipped quarantine"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transferId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QuarantineApplied"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Incoming transfer quarantined for compliance review"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transferId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The system emits ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QuarantineSkipped"]}," events when an incoming transfer bypasses quarantine due to the account's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipQuarantineFrom"]}," configuration. This occurs only for transfers between internal ","Ripple Custody"," accounts. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/compliance/transaction-screening/concept#skip-quarantine-for-internal-transfers"},"children":["Skip quarantine for internal transfers"]}," for more information."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload examples:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"ComplianceConfigurationUpdated","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"b22cfc18-df37-49a1-b7e9-1b6c3f83b32b\",\n    \"payload\": {\n        \"accountReference\": {\n            \"id\": \"d664a3f3-d5f0-44c1-9588-326b0f00aced\",\n            \"domainId\": \"b22cfc18-df37-49a1-b7e9-1b6c3f83b32b\"\n        },\n        \"skipQuarantineFrom\": \"Instance\",\n        \"revision\": 3,\n        \"modifiedBy\": {\n            \"id\": \"6ac20654-450e-29e4-65e2-1bdecb7db7c4\",\n            \"domainId\": \"b22cfc18-df37-49a1-b7e9-1b6c3f83b32b\"\n        },\n        \"type\": \"ComplianceConfigurationUpdated\"\n    },\n    \"id\": \"91cb7c39-880c-32f9-9ad5-51d5e14193d7\",\n    \"sequenceNumber\": 366,\n    \"savedAt\": \"2026-03-23T10:47:46.344Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"QuarantineSkipped","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"da2751f2-f28d-4bc2-9522-90c44790d97e\",\n    \"payload\": {\n        \"transferId\": \"cd00250c-096d-4d15-9273-6be3b854ef1f\",\n        \"type\": \"QuarantineSkipped\"\n    },\n    \"id\": \"e332a25d-a036-3008-87bf-e138a660ea1a\",\n    \"sequenceNumber\": 354,\n    \"savedAt\": \"2026-03-17T15:05:13.596Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"QuarantineApplied","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"domainId\": \"b22cfc18-df37-49a1-b7e9-1b6c3f83b32b\",\n    \"payload\": {\n        \"transferId\": \"5a22b0ef-d306-4d95-a063-a5b751934b1b\",\n        \"type\": \"QuarantineApplied\"\n    },\n    \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n    \"sequenceNumber\": 202,\n    \"savedAt\": \"2026-03-17T13:22:30.168Z\"\n}\n","lang":"json"},"children":[]}]}]}]},"headings":[{"value":"Event payload reference","id":"event-payload-reference","depth":1},{"value":"Genesis event","id":"genesis-event","depth":2},{"value":"Intent events","id":"intent-events","depth":2},{"value":"Transaction events","id":"transaction-events","depth":2},{"value":"Compliance events","id":"compliance-events","depth":2}],"frontmatter":{"seo":{"title":"Event payload reference"}},"lastModified":"2026-08-04T20:25:11.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/reference/events-and-webhooks/event-payload-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}