API references
Search documentation... ⌘K
API references
Open merchant dashboard
Merchant API
All our references

List Webhook Endpoints

Returns an array of all webhook endpoints for the merchant.

See find-webhook for the complete list of response attributes.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/list-webhooks HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{}
Returns: array
New to Reservepay? Read our guide on how to call endpoints to get started.
Response attributes
Attribute Description
webhook_id
string

The ID of the webhook endpoint.
name
string

The name of the webhook endpoint.
enabled
boolean

Whether the webhook endpoint is enabled and will receive events.
api_version
string

The API version that the webhook endpoint is configured for.
destination_url
string

The URL where webhook events will be sent.
protocol
string

The protocol used for sending webhook events (e.g., HTTPS).
verification_key
string

The key used to verify webhook signatures.
events
array

List of event types that this webhook endpoint will receive.
created_at
number

The timestamp of the key creation as a Unix timestamp.
Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/list-webhooks" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{}'
Learn how to run these code samples in your terminal by reading our guide.