Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripple Labs Webhooks API

Used to manage webhooks

Ripple Labs Webhooks API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 10 operations across 6 paths, and defines 21 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.

10 operations 6 paths 21 schemas 2 DELETE4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ripple Labs Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 10

Used to manage webhooks

GET
/v2/webhooks
List webhooks
WebhookService_ListWebhooks 79 params → 200400401403404default
POST
/v2/webhooks
Create webhooks
WebhookService_CreateWebhook body → 200400401403404default
GET
/v2/webhooks/{id}
Get webhooks
WebhookService_GetWebhook 1 param → 200400401403404default
DELETE
/v2/webhooks/{id}
Delete webhooks
WebhookService_DeleteWebhook 1 param → 200400401403404default
GET
/v2/webhooks/{webhookId}/subscriptions
List subscriptions
WebhookService_ListSubscriptions 46 params → 200400401403404default
POST
/v2/webhooks/{webhookId}/subscriptions
Create webhook subscriptions
WebhookService_CreateSubscriptions 1 param body → 200400401403404default
GET
/v2/webhooks/{webhookId}/subscriptions/{subscriptionId}
Get subscriptions
WebhookService_GetSubscription 2 params → 200400401403404default
DELETE
/v2/webhooks/{webhookId}/subscriptions/{subscriptionId}
Delete subscriptions
WebhookService_DeleteSubscription 2 params → 200400401403404default
POST
/v2/webhooks/{webhookId}/subscriptions:list
List subscriptions
WebhookService_ListSubscriptions2 1 param body → 200400401403404default
POST
/v2/webhooks:list
List webhooks
WebhookService_ListWebhooks2 body → 200400401403404default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are v2Webhook (14 properties), v2TimestampFilter (9 properties), v2StringFilter (8 properties), v2WebhookFilter (8 properties). Each schema is shown below with its type and property counts.

v2Subscription
object
7 properties 7 required
v2ListSubscriptionsResponse
object
2 properties
v2SubscriptionFilter
object
6 properties
protobufAny
object
1 property
v2DeleteWebhookResponse
object
v2ListWebhooksResponse
object
2 properties
TimestampFilterTimestampRange
object
2 properties
v2TimestampFilter
object
9 properties
v2WebhookFilter
object
8 properties
v2CreateWebhookRequest
object
3 properties 2 required
v2FilterResponse
object
3 properties 1 required
v2StringFilter
object
8 properties
v2Webhook
object
14 properties 11 required
v2SubscriptionConfig
object
2 properties 2 required
v2SortOrder
string
v2SubscriptionDomain
string
v2DeleteSubscriptionResponse
object
v2FilterRequest
object
4 properties
v2SubscriptionScope
string
v2ListWebhooksRequest
object
5 properties
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-webhooks-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API