Creating a Webhook Endpoint
Via API
Response (201 Created):
The secret_key is only included in the response when creating an endpoint. Save it immediately — it cannot be retrieved later.
Via Dashboard
You can also manage webhooks in your paywise dashboard.
API Reference
List Endpoints
Returns all webhook endpoints for your company. Optionally filter by status:
Retrieve an Endpoint
Update an Endpoint
Update any writable field. For example, to add a new event subscription:
Writable fields:
url — Endpoint URL (must be HTTPS)
enabled — Enable or disable the endpoint
events — List of subscribed event types
description — Optional description
max_consecutive_failures — Auto-disable threshold (1–1000)
Delete an Endpoint
Send a Test Event
Send a test event to verify your endpoint is working correctly:
The test event will be delivered with "test": true in the payload.
List Deliveries
View delivery history for a specific endpoint:
Or list all deliveries across all endpoints:
Delivery statuses: pending, success, failed, retrying