Webhook endpoint tools
Create, configure, rotate, replay, and version webhook endpoints.
The largest tool group. Twelve tools cover the full webhook lifecycle so you can manage delivery without ever opening the Merchant Portal.
Configuration
create_webhook_endpoint
Create a new endpoint. Returns the whsec_... signing secret once — capture it.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | false | true | false |
Required: url (must be HTTPS), enabled_events (array of event types or ["*"]; supports wildcards like order.*). Optional: description, api_version (pin the endpoint to a specific webhook schema).
list_webhook_endpoints
List all endpoints on the merchant.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
true | false | true | false |
get_webhook_endpoint
Get one endpoint and its configured events.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
true | false | true | false |
update_webhook_endpoint
Change url, enabled_events, description, status (enabled/disabled), or api_version.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | false | true | false |
delete_webhook_endpoint
Remove an endpoint. EPD stops delivering to it immediately.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | true | true | false |
Operations
test_webhook_endpoint
Send a synthetic test event to the endpoint so you can confirm round-trip delivery.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | false | false | false |
replay_webhook_event
Re-deliver a specific past event — useful after a deployment that fixes a handler bug.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | false | false | false |
rotate_webhook_secret
Rotate the endpoint’s signing secret. Both old and new secrets are accepted during a grace period so you can deploy without missing events.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | false | true | false |
upgrade_webhook_version
Move an endpoint to a newer webhook schema version. Some payload shapes will change.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | true | true | false |
downgrade_webhook_version
Move an endpoint to an older webhook schema version.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
false | true | true | false |
Diagnostics
list_webhook_delivery_logs
List delivery attempts (success or failure) for an endpoint with filters and pagination.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
true | false | true | false |
list_webhook_events
List events created on the merchant — independent of delivery.
| readOnly | destructive | idempotent | openWorld |
|---|---|---|---|
true | false | true | false |
upgrade_webhook_version and downgrade_webhook_version are flagged destructive because the payload shape on the wire changes — handlers that hard-code field paths can break. Test in sandbox first.