Webhooks

Aperçu

Il est souvent utile de savoir quand votre déploiement est terminé, quel que soit son état PRÊT ou ERREUR. Vous pouvez utiliser un webhook avec un déploiement. Voici comment cela fonctionne :

Nous effectuerons une requête HTTP POST vers l'URL fournie lorsque votre déploiement sera terminé. Cette requête contient un corps JSON avec les mêmes données fournies par notre route /v1/status/{request_id}. Nous n'attendons aucune réponse de votre part.

Le délai d'attente par défaut pour le webhook est de 10 secondes. Si le webhook ne répond pas dans ce délai, vous ne recevrez plus aucune notification.

Exemple de webhook de déploiement

POST requête vers /v1/deploy (Référence API)

Incluez votre Jeton API dans vos en-têtes comme ceci :

{
  "Content-Type": "application/json",
  "Authorization": "token super_secret_token_1234"
}

Payload REST :

{
  "app_name": "speedtest",
  "version_name": "v1",
  "ip_list": ["1.1.1.1"],
  "webhook_url": "https://ptsv2.com/t/0n7by-1652897234/post"
}

Flux d'appels du webhook de déploiement

Le diagramme de séquence suivant montre le flux d'appels d'un webhook de déploiement.