Aller au contenu principal

Webhooks d’applications

Les marketplace apps installées peuvent définir des endpoints webhook à portée marchande pour la livraison d’événements spécifiques à l’app.

Famille de routes implémentée​

Les routes actuelles incluent :

  • GET /api/v1/merchant/apps/installations/{installationId}/webhook_endpoints
  • POST /api/v1/merchant/apps/installations/{installationId}/webhook_endpoints
  • POST /api/v1/merchant/apps/webhook_endpoints/{endpointId}
  • POST /api/v1/merchant/apps/webhook_endpoints/{endpointId}/rotate_secret

Des chemins marchands compatibles hérités peuvent aussi être disponibles sous api/merchant/apps/*.

Lister les endpoints webhook d’une installation​

GET /api/v1/merchant/apps/installations/{installationId}/webhook_endpoints

Créer un endpoint webhook​

POST /api/v1/merchant/apps/installations/{installationId}/webhook_endpoints

Les champs de requête typiques incluent :

  • url

La réponse de création inclut le secret de signature généré et les métadonnées de l’endpoint créé.

Mettre à jour un endpoint webhook​

POST /api/v1/merchant/apps/webhook_endpoints/{endpointId}

Les champs de requête typiques incluent :

  • url
  • enabled

Métadonnées d’endpoint​

Les métadonnées d’endpoint incluent :

  • l’identifiant d’endpoint
  • l’identifiant d’installation
  • l’URL
  • l’indicateur d’activation
  • les échecs consécutifs
  • l’horodatage de désactivation
  • l’horodatage de dernière livraison
  • le statut de dernière livraison

Note opérationnelle​

Les endpoints webhook d’app sont distincts de la famille de routes publique générale webhook_endpoints. Ce sont des endpoints du framework d’apps à portée installation, appartenant à un marchand.

Sections liées​