Skip to main content
GET
/
api
/
webhooks
Get all webhook registrations
curl --request GET \
  --url https://app.sandbox.rio.trade/api/webhooks \
  --header 'x-api-key: <api-key>'
[
  {
    "userId": "66562bc04fe8bf83c577c178",
    "type": "orders",
    "url": "https://app.test.rio.trade/en/account",
    "id": "66733d33222710ab2785dc62",
    "retryOnFailure": true
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
userId
string

User id to filter the results.

​
page
integer

Used to specify the current page you want to get in the paging results.

​
limit
integer

Used to specify the maximum number of records to be returned on a single page.

Response

200 - application/json

OK

​
userId
string

Id of the user that the webhook is for

Example:

"66562bc04fe8bf83c577c178"

​
type
enum<string>

Type of webhook

Available options:
orders,
bank-accounts,
users
​
url
string

URL to send the webhook to

Example:

"https://app.test.rio.trade/en/account"

​
id
string

Id of the webhook registration

Example:

"66733d33222710ab2785dc62"

​
retryOnFailure
boolean

Whether the webhook will retry on failure

Example:

true