İçeriğe geç
Apex Settlement
Webhooks

Rotate a webhook endpoint's signing secret

Gereken izincustomer:webhooks:manageAPI referansındaki uç nokta açıklamaları İngilizcedir.
POST
/v1/webhooks/{id}/rotate-secret

Replaces the endpoint's signing secret at once: every attempt from now on, retries of older deliveries included, is signed with the new one. The answer carries the new whsec_… secret, shown here only.

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

Yetkilendirme

ApiKey
headerYetkilendirmeBearer <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.

Yol parametreleri

id*string

The endpoint's id.

Biçimuuid

Yanıt gövdesi

OK

application/json
  1. response
endpoint*
secret*string

secret signs every delivery to this endpoint; it is shown in this answer only.

Örnek istek
curl -X POST 'http://localhost:3480/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/rotate-secret'
Örnek yanıt
{  "endpoint": {    "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"  },  "secret": "whsec_9fJx2Lq7Rk4mTz8vNc3bWs6yHd1gPa5e"}