Skip to Content
Apex Settlement
Webhooks

List webhook endpoints

Required permissioncustomer:webhooks:manage
GET
/v1/webhooks

The Customer's webhook endpoints, newest first, with the event types each receives, whether it is active or disabled (and why), its last successful delivery and since when it has been failing. Signing secrets are never shown again after registration or rotation.

Requires the customer:webhooks:manage permission. Not available for an End Customer: Apex-End-Customer is refused.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'http://localhost:3480/v1/webhooks'
Example Response
[  {    "created_at": "2026-11-01T12:00:00Z",    "disabled_reason": "no successful delivery for 24 hours",    "events": [      "payout.updated",      "deposit.received"    ],    "failing_since": "2019-08-24T14:15:22Z",    "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",    "last_success_at": "2026-11-12T09:31:06Z",    "status": "active",    "updated_at": "2026-11-01T12:00:00Z",    "url": "https://hooks.example.com/apex"  }]