commit b3941efe803064a37dbbfad6d69378137eadfd20
parent ca1ac2387e9bace0f0ac159dc49313a57e45a074
Author: bohdan-potuzhnyi <bohdan.potuzhnyi@gmail.com>
Date: Tue, 17 Dec 2024 12:27:34 +0100
update of the webhook description to be more precise
Diffstat:
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/taler-user-guide.rst b/taler-user-guide.rst
@@ -298,9 +298,12 @@ you can specify which URL, which HTTP headers, which HTTP method and what HTTP
body to send to the Webhook. Webhooks are automatically retried (with
increasing delays) when the target server returns a temporary error.
-`Mustach templates <https://mustache.github.io/mustache.5.html>`__ are used
-when defining the contents of Webhooks. Depending on the triggering event,
-the templates will be expanded with event-specific data.
+`Mustach templates <https://mustache.github.io/mustache.5.html>`__ and limited
+version of it are used when defining the contents of Webhooks.
+Depending on the triggering event, the templates will be expanded with event-specific
+data. Limited in this case means that only a specific string is being replaced
+with the event-specific data, no support for parsing conditions or nested structures
+is provided.
Order pay events
@@ -331,7 +334,7 @@ Mustache templating engine:
Order settled events
--------------------
-For "order_settled" events, the backend will provide the following information to the
+For "order_settled" events, the backend will provide the following information to the limited
Mustache templating engine:
* order_id: The unique identifier of the order that has been fully settled (all payments completed and wired to the merchant).
@@ -340,7 +343,7 @@ Mustache templating engine:
Category added events
---------------------
-For "category_added" events, the backend will provide the following information to the
+For "category_added" events, the backend will provide the following information to the limited
Mustache templating engine:
* webhook_type: "category_added".
@@ -352,7 +355,7 @@ Mustache templating engine:
Category updated events
-----------------------
-For "category_updated" events, the backend will provide the following information to the
+For "category_updated" events, the backend will provide the following information to the limited
Mustache templating engine:
* webhook_type: "category_updated".
@@ -366,7 +369,7 @@ Mustache templating engine:
Category deleted events
-----------------------
-For "category_deleted" events, the backend will provide the following information to the
+For "category_deleted" events, the backend will provide the following information to the limited
Mustache templating engine:
* webhook_type: "category_deleted".
@@ -377,7 +380,7 @@ Mustache templating engine:
Inventory added events
----------------------
-For "inventory_added" events, the backend will provide the following information to the
+For "inventory_added" events, the backend will provide the following information to the limited
Mustache templating engine:
* webhook_type: "inventory_added".
@@ -399,7 +402,7 @@ Mustache templating engine:
Inventory updated events
------------------------
-For "inventory_updated" events, the backend will provide the following information to the
+For "inventory_updated" events, the backend will provide the following information to the limited
Mustache templating engine:
* webhook_type: "inventory_updated".
@@ -434,7 +437,7 @@ Mustache templating engine:
Inventory deleted events
------------------------
-For "inventory_deleted" events, the backend will provide the following information to the
+For "inventory_deleted" events, the backend will provide the following information to the limited
Mustache templating engine:
* webhook_type: "inventory_deleted".
