Merge pull request #298 from mittwald/fix/issue-293

document successful status codes for extension lifecycle webhooks
mittwald · Oct 24, 2024 · dff5660 · dff5660
2 parents ea73722 + 19a0b28
commit dff5660
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/contribution/3-overview/3-concepts/2-lifecycle-webhooks.mdx b/docs/contribution/3-overview/3-concepts/2-lifecycle-webhooks.mdx
@@ -16,6 +16,7 @@ For an overview of the possible placeholders available in lifecycle webhook URL
 
 The mStudio executes all webhook calls `at least once`.
 Therefore, you must design the webhook endpoints so that multiple calls do not result in errors.
+Every status code less than `200` or greater than or equal `300` is considered a failure.
 The webhook calls are executed asynchronously to the action that triggered them.
 If a webhook call fails, the webhook payload is rebuilt.
 The request is then signed and resubmitted.

diff --git a/...ontent-docs/current/contribution/3-overview/3-concepts/2-lifecycle-webhooks.mdx b/...ontent-docs/current/contribution/3-overview/3-concepts/2-lifecycle-webhooks.mdx
@@ -14,6 +14,7 @@ Für eine Übersicht, welche Platzhalter für Lifecycle Webhooks verwendet werde
 ## Quality of Service (QoS) für die Zustellung von Lifecycle Webhooks
 
 Alle Webhooks werden `at least once` aufgerufen und sind somit so zu entwerfen, dass mehrfache Aufrufe nicht zu Fehlern führen.
+Jeder Statuscode kleiner als `200` oder größer gleich `300` wird als fehlgeschlagen interpretiert.
 Die Webhooks werden asynchron zu der Aktion, die diese ausgelöst hat, ausgeführt.
 Bei Fehlschlägen wird der Webhook-Payload erneut gebaut, der Request neu signiert und versendet.
 Dabei wird mit einem gedeckelten exponentiellen Backoff gearbeitet, um die Anzahl der Versuche zu begrenzen.