Skip to main content
These are the requirements and steps for registering a new webhook.

​
Requirements to start the flow.

API key

Have an API key (Tutorial here).

​
Registration flow

1

Pick the type of webhook you need

The type goes in the URL path rather than the body, so you register one webhook per type. The available types are orders, for updates as an order moves through its lifecycle, bank-accounts, for changes to your registered bank accounts, and users, for changes to your users.
2

Register the endpoint

Send the address that should receive the events in the url field. Rio will send a POST request there every time an event of that type happens.
Setting retryOnFailure to true makes Rio retry a failed delivery up to 5 times with exponential backoff. If you leave it out, a failed delivery is only attempted once, so turn it on unless you have another way of catching missed events.

Go to Register a new webhook

Register a new webhook to receive notifications about events in your account.
3

Save the secret

The response contains the id of the registration and a secret. Store the secret somewhere safe right away, because it is only returned by this call and cannot be read back later. If you lose it you have to delete the registration and create a new one.The payloads Rio sends are encrypted, and this secret is the key you decrypt them with.

Go to decrypt a webhook

4

Check or change the registration later

You can list your registrations to confirm the URL and type are what you expect. Updating lets you point an existing registration at a new url or change retryOnFailure, and it keeps the same secret.

Go to get all webhook registrations

​
Webhook registration through the platform.

To register the webhook, you must log in to the platform, navigate to the webhooks section in your account settings, and save the secret once registered.
Disclaimer: All technical documentation is subject to the terms and conditions, which apply supplementarily and take precedence over the documentation.