Skip to main content
GET
Get a webhook registration
v1 (legacy). This page documents the API before the v2 update. The v1 format is not enabled for new accounts and must be enabled on your account by your account manager. New integrations should use the current documentation. To update an existing integration, follow the migration guide.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Id of the webhook to be obtained.

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