From 13fffe1323d4a4b3ae2f83a251a5765571cb5a49 Mon Sep 17 00:00:00 2001
From: stefanprodan <stefan.prodan@gmail.com>
Date: Thu, 3 Jan 2019 18:46:36 +0200
Subject: [PATCH] Document webhooks status codes

---
 docs/gitbook/how-it-works.md | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/docs/gitbook/how-it-works.md b/docs/gitbook/how-it-works.md
index 2dc5ada6..53fd864c 100644
--- a/docs/gitbook/how-it-works.md
+++ b/docs/gitbook/how-it-works.md
@@ -132,7 +132,7 @@ And the time it takes for a canary to be rollback:
 controlLoopInterval * threshold 
 ```
 
-#### HTTP Metrics
+### HTTP Metrics
 
 The canary analysis is using the following Prometheus queries:
 
@@ -205,7 +205,7 @@ histogram_quantile(0.99,
 )
 ```
 
-#### Webhooks
+### Webhooks
 
 The canary analysis can be extended with webhooks. 
 Flagger would call a URL (HTTP POST) and determine from the response status code (HTTP 2xx) if the canary is failing or not.
@@ -234,6 +234,13 @@ Webhook payload:
         "token":  "16688eb5e9f289f1991c"
     }
 }
-
+```
+
+Response status codes:
+
+* 200-202 - advance canary by increasing the traffic weight
+* timeout or non-2xx - halt advancement and increment failed checks
+
+On a non-2xx response Flagger will include the response body (if any) in the failed checks log and Kubernetes events.