Renouveler le secret de signature

POST/v1/webhook-endpoints/{webhookEndpoint}/rotate-secret

L’ancien secret cesse de signer aussitôt. Le nouveau n’apparaît que dans cette réponse.

Droit de clé restreinte : webhooks:write.

Paramètres de chemin

webhookEndpointtexteobligatoire
L'identifiant, we_….

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend l’objet points de terminaison.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/webhook-endpoints/we_…/rotate-secret \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/webhook-endpoints/we_…/rotate-secret', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/webhook-endpoints/we_…/rotate-secret', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "id": "we_034t7hBCW2rOZqFLSge7q0",
  "object": "webhook_endpoint",
  "url": "https://exemple.fr/hook",
  "description": null,
  "enabled_events": [
    "claim.*"
  ],
  "status": "enabled",
  "livemode": false,
  "disabled_at": null,
  "created": 1794004695,
  "secret": "whsec_…"
}