The 'event' endpoint allows publishing an xApp event in the "Requests" event list of a user, while sending a Push notification pointing to the event.

xApps are embedded apps. Publishing an xApp and calling xApp API endpoints are only available for XRPL Labs / XUMM partners.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

❗️

xApp Event permissions

Please note that xApp Event push notifications are only available for xApps whitelisted for push by XRPL Labs.

The data in the data property will be returned as origin.data in the xapp/ott/:token

The user_token can be obtained by requesting the user to sign a User Sign In payload using the regular payload method.

When you want to remove the Event from the Requests tab (eg. because the user tapped the push notification and resolved the request) use the payload/:payload_uuid method. Use the returned uuid (payload UUID).

Body Params
string
required

The User Token to send the event & push notification to. Obtained with a Sign Request (payload)

string

Push notification subtitle & subtitle in the Event list (Request tab)

string
required

Description (text) for the push notification

boolean
Defaults to false

Only create the event in the user's Event list, don't send a push notification

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json