Créer un point de terminaison

POST/v1/webhook-endpoints

Le secret de signature n’apparaît que dans cette réponse, sous secret.

Droit de clé restreinte : webhooks:write.

Corps de la requête

urltexteobligatoire
L'adresse à prévenir. En production, en HTTPS. Une adresse de réseau privé est refusée.
descriptiontexteou null
enabled_eventstableau de texteobligatoire
Un type exact, un joker claim.*, ou *.
statusénumération
enableddisabled

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 \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://exemple.fr/hook",
    "enabled_events": [
      "claim.*"
    ]
  }'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/webhook-endpoints', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'url' => 'https://exemple.fr/hook',
        'enabled_events' => [
            'claim.*',
        ],
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/webhook-endpoints', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    url: 'https://exemple.fr/hook',
    enabled_events: [
      'claim.*'
    ]
  }),
})
const object = await response.json()

Réponse 201


{
  "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_…"
}