Webhooks (WebhookApi)

Le module WebhookApi permet de configurer des webhooks pour recevoir des notifications d’événements en temps réel.

Accès : client.webhook

Méthodes

`set`

Configure un webhook pour un type d’événement.

Exemple


const response = await client.webhook.set({
  appId: "app_id",
  apiKey: "user_api_key",
  eventType: "ORDER_RECEIVED",
  url: "https://example.com/webhook",
  isActive: true
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API
`eventType`	string	Oui	Type d’événement
`url`	string	Oui	URL du webhook
`isActive`	boolean	Non	Activer/désactiver

Types d’événements : PAYMENT_RECEIVED, PAYMENT_CONFIRMED, PAYMENT_FAILED, ORDER_RECEIVED, ORDER_CONFIRMED, ORDER_SHIPPED, ORDER_CANCELLED, ORDER_REFUNDED, APPOINTMENT_RECEIVED, APPOINTMENT_CONFIRMED, APPOINTMENT_COMPLETED, APPOINTMENT_CANCELLED, WITHDRAW_REQUESTED, WITHDRAW_COMPLETED, WITHDRAW_FAILED

Réponse


{
  "success": true,
  "data": {
    "id": "webhook_id",
    "eventType": "ORDER_RECEIVED",
    "url": "https://example.com/webhook",
    "isActive": true
  }
}

`list`

Liste tous les webhooks configurés.

Exemple


const response = await client.webhook.list({
  appId: "app_id",
  apiKey: "user_api_key"
});

`delete`

Supprime un webhook.

Exemple


const response = await client.webhook.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  eventType: "ORDER_RECEIVED"
});

`getLogs`

Récupère les logs d’envoi des webhooks.

Exemple


const response = await client.webhook.getLogs({
  appId: "app_id",
  apiKey: "user_api_key",
  limit: 50
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API
`limit`	number	Non	Nombre de logs
`offset`	number	Non	Décalage
`eventType`	string	Non	Filtrer par type

Réponse


{
  "success": true,
  "data": {
    "logs": [
      {
        "id": "log_id",
        "eventType": "ORDER_RECEIVED",
        "statusCode": 200,
        "status": "SUCCESS",
        "duration": 150,
        "createdAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "total": 100,
    "hasMore": true
  }
}