Webhooks - Endpoints

Rotate a webhook endpoint secret

Issue a new signing secret for the endpoint and return it. The previous secret keeps verifying for 24 hours, so a receiver can accept both while it rolls over. This and endpoint creation are the only responses that carry a secret. Authenticate with an API key or a signed-in dashboard session. Costs no credits.

post/v1/webhooks/endpoints/{id}/rotate

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/webhooks/endpoints/{id}/rotate
  • Auth: API key in header X-API-Key

Path parameters

idstring uuid required
Example:3c1f0a52-8d6b-4f0e-9b1a-6f2c4d8e9a10

Endpoint identifier.

Response

The new signing secret

successboolean
notestring

How long the previous secret keeps verifying.

Example response

{
  "success": true,
  "data": {
    "secret": "whsec_6f1c0b2a4d8e5f3a9c7b1e0d2f4a6c8b1d3e5f7a9c0b2d4e6f8a1c3b5d7e9f0a"
  },
  "note": "Previous secret remains valid for 24 hours."
}

Changes

No recorded changes to this operation across all 1 revision of this API.