Reference API

Configurer le webhook partenaire

PATCH /api/v1/partners/me/webhook et PATCH /api/v1/partners/:partnerId/webhook — enregistrer l'URL et le secret du webhook sortant.

Cette page couvre la variante self-service partenaire: PATCH /api/v1/partners/me/webhook.

La doc interactive ci-dessous utilise la spec Swagger réelle de l'API. Tu peux voir le body attendu, les validations et tester l'appel directement.

Résumé rapide

  • Méthode: PATCH
  • Route: /api/v1/partners/me/webhook
  • Auth: x-api-key partenaire ou JWT
  • But: enregistrer l'URL de réception et le secret de signature

Quand l'appeler

Utilise cet endpoint:

  • pendant l onboarding sandbox,
  • avant toute recette webhook,
  • a chaque rotation de secret ou changement d URL de reception.

Le secret n'est jamais renvoyé en clair. La réponse indique seulement s'il est présent côté plateforme.

Points d attention

  • L URL webhook doit etre accessible publiquement en HTTPS.
  • Le handler partenaire doit verifier x-insurance-signature sur le body brut.
  • Le traitement doit etre idempotent et repondre 2xx rapidement.

Référence interactive

PATCH
/api/v1/partners/me/webhook
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "http://localhost:3210/api/v1/partners/me/webhook" \  -H "Content-Type: application/json" \  -d '{    "webhookUrl": "https://partner.example.com/webhooks/insurance"  }'
Empty

Voir aussi

On this page