Docs
Search
⌃K

Webhook Registrations

Overview

The following APIs allow you to register for webhooks and manage your registrations. You can make a call to list all the available events at any time; as more get added, they will be present in that response.
Currently, a single client is limited to 10 webhook registrations; however, you can subscribe to several events under the same webhook URL.
Note: When you create a webhook registration, you will receive a secret key. Store that key securely, as you will later use it to validate your webhook data on receipt.

List Available Webhook Events

get
https://api.ratio.me
/v1/webhooks/events
Get all webhook events

Retrieve Subscribed Webhooks

get
https://api.ratio.me
/v1/webhooks
This returns the client's webhooks
get
https://api.ratio.me
/v1/webhooks/{webhookId}
This returns the requested webhook

Subscribe to a New Webhook

post
https://api.ratio.me
/v1/webhooks
This creates a new webhook

Update a Webhook Subscription

patch
https://api.ratio.me
/v1/webhooks/{webhookId}
This updates the requested webhook

Unsubscribe a Webhook

delete
https://api.ratio.me
/v1/webhooks/{webhookId}
This deletes the requested webhook