API Webhooks
Gérez les endpoints webhook de manière programmatique.
Famille de routes actuellement implémentée : api/v1/webhook-endpoints
Objet Webhook Endpoint
{
"id": "we_abc123",
"object": "webhook_endpoint",
"url": "https://yoursite.com/webhooks/ikawaari",
"enabled_events": ["payment_intent.succeeded", "payment_intent.payment_failed"],
"enabled": true
}
Endpoints
| Méthode | Endpoint | Description |
|---|---|---|
POST | /api/v1/webhook-endpoints | Créer un endpoint webhook |
GET | /api/v1/webhook-endpoints/{id} | Récupérer un endpoint webhook |
GET | /api/v1/webhook-endpoints | Lister les endpoints webhook |
POST | /api/v1/webhook-endpoints/{id} | Mettre à jour un endpoint webhook |
POST | /api/v1/webhook-endpoints/{id}/rotate_secret | Faire tourner un secret de signature webhook |
Les API du dashboard marchand exposent aussi des opérations supplémentaires de gestion des webhooks sous les familles de routes marchandes, notamment pour les tests, les replays et l’inspection des tentatives.
Créer un endpoint webhook
POST /api/v1/webhook-endpoints
| Paramètre | Type | Requis | Description |
|---|---|---|---|
url | string | Non | URL recevant les événements webhook. |
enabled_events | string[] | Non | Liste des types d’événements auxquels s’abonner. |
La réponse de création inclut aussi secret. Conservez-le côté serveur : il sert à vérifier les signatures webhook.
{
"url": "https://yoursite.com/webhooks/ikawaari",
"enabled_events": ["payment_intent.succeeded", "payment_intent.payment_failed"]
}
Mettre à jour un endpoint webhook
POST /api/v1/webhook-endpoints/{id}
| Paramètre | Type | Requis | Description |
|---|---|---|---|
url | string | Non | Nouvelle URL webhook. |
enabled_events | string[] | Non | Nouvelle liste d’événements abonnés. |
enabled | boolean | Non | Active ou désactive l’endpoint. |