lomi.
Webhooks

Mettre à jour un webhook

Mettre à jour un webhook

Aperçu

Mettre à jour un webhook

Quand l’utiliser

Utilisez pour changer l’URL de destination, les événements écoutés ou la rotation de secret.

À savoir

Après rotation du secret, mettez à jour la vérification de signature côté serveur avant de désactiver l’ancien secret.

Voir aussi

Créer un webhook · Webhooks

Authentification

Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Vue d’ensemble). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.

Endpoint

PATCH /webhooks/{id}

URLs de base :

  • https://sandbox.api.lomi.africa
  • https://api.lomi.africa

Requête

Paramètres d’URL

Pas d’autre paramètre dans l’URL.

Paramètres de requête

Aucun paramètre de requête.

Corps de la requête

Corps JSON.

Schéma: object

ChampObligatoireTypeDescription
urlNonstring-
is_activeNonboolean-
authorized_eventsNonarray<string>-
metadataNonobject-

Exemple de corps :

{
  "url": "string",
  "is_active": true,
  "authorized_events": [
    "string"
  ]
}

Réponses

StatutDescription
200Webhook mis à jour avec succès

Erreurs

Les erreurs suivent un format JSON standard. 401 : clé manquante ou invalide. 404 : ressource introuvable. 429 : trop de requêtes. Pour les créations, envoyez une clé d’idempotence si votre flux le permet.

Exemple

curl -sS -X PATCH "https://sandbox.api.lomi.africa/webhooks/id_value" \
  -H "X-API-KEY: $LOMI_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","is_active":true,"authorized_events":["string"]}'

OpenAPI

  • operationId: WebhooksController_update
  • Operation: PATCH /webhooks/{id}

Schémas complets et Try it : référence API.

Sur cette page