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

Reconnect a Webhook Endpoint

Update an existing webhook endpoint connection details.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/reconnect-webhook HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
webhook_id: string,
name: string,
protocol: string,
api_version: string,
destination_url: string,
events: array,
}
Returns: boolean
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
webhook_id string

Required. The ID of the webhook to reconnect

name string

Required. A name for this webhook endpoint

protocol string

Required. The protocol to use for sending webhook events.

Allowed values:
  • http
  • https
api_version string

Required. The API version to use for webhook events. Must be a valid date format (YYYY-MM-DD) from the available API versions.

destination_url string

Required. The URL where webhook events will be sent. Must be a valid HTTP/HTTPS URL and match the specified protocol.

events array

Required. List of events for webhook

Allowed values:
  • PAYMENT_COMPLETED
  • PAYMENT_VOIDED
  • PAYMENT_REVERSED
  • PAYMENT_AUTHORIZED
  • PAYMENT_EXPIRED
  • PAYOUT_COMPLETED
Errors specific to this endpoint
NOT_FOUND

This error occurs when the webhook endpoint with the provided ID could not be found.

INVALID_ARGUMENTS

This error occurs when the provided arguments are invalid. For example: - Missing required fields - Invalid protocol (must be http or https) - Invalid URL format or protocol mismatch - Invalid events - Invalid API version (must be a valid date from the available API versions)

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/reconnect-webhook" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "webhook_id": "whe_eJF6e521es"
      }'
Learn how to run these code samples in your terminal by reading our guide.