lomi.
Webhooks

Mettre à jour un webhook

Mettre à jour un webhook

Aperçu

Mettre à jour un webhook

Quand utiliser cet endpoint

Utilisez cet endpoint quand vous devez exécuter PATCH /webhooks/{id} (Mettre à jour un webhook).

Authentification

Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Aperçu de l’intégration). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.

Point de terminaison

PATCH /webhooks/{id}

URLs de base :

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

Requête

Paramètres de chemin

Aucun paramètre de chemin au-delà du motif d’URL.

Paramètres de requête

Aucun paramètre de requête.

Corps de la requête

Charge utile 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 le format JSON standard (code de statut et message lisible par machine). Validez les entrées avant appel ; 401 indique une clé manquante/invalide, 404 une ressource introuvable pour cette organisation, 429 une limitation de débit. Pour les retries sûrs sur les créations, envoyez une clé d’idempotence quand votre flux le permet.

Exemple

curl -sS -X PATCH "https://sandbox.api.lomi.africa/webhooks/id_value" \
  -H "X-API-KEY: $LOMI_API_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. Contrat machine : openapi.json à la racine des docs.

Sur cette page