Skip to content

Commit 8fd5b29

Browse files
authored
Fixes #941 - Add hint about unsupported variable features in webhooks
1 parent a2c2662 commit 8fd5b29

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

locale/admin-docs.pot

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: Zammad Admin Documentation pre-release\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-08-25 12:46+0200\n"
11+
"POT-Creation-Date: 2025-10-02 13:23+0200\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language-Team: LANGUAGE <[email protected]>\n"
@@ -6180,8 +6180,8 @@ msgstr ""
61806180
#: ../manage/slas/index.rst:94
61816181
#: ../manage/trigger.rst:28
61826182
#: ../manage/trigger.rst:28
6183-
#: ../manage/webhook.rst:45
6184-
#: ../manage/webhook.rst:45
6183+
#: ../manage/webhook.rst:47
6184+
#: ../manage/webhook.rst:47
61856185
#: ../system/core-workflows.rst:30
61866186
#: ../system/core-workflows.rst:30
61876187
#: ../system/objects.rst:32
@@ -10747,63 +10747,63 @@ msgstr ""
1074710747
msgid "Webhooks are a way to integrate Zammad with other web services or applications, allowing them to subscribe to live updates about tickets instead of having to poll the Zammad server every *n* minutes."
1074810748
msgstr ""
1074910749

10750-
#: ../manage/webhook.rst:8
10751-
msgid "⌛ **Webhooks may not arrive immediately.**"
10750+
#: ../manage/webhook.rst:10
10751+
msgid "Webhooks may not arrive immediately. They are sent out with the same priority and order as email triggers. If webhook dispatch fails (e.g. because the receiving server is misconfigured), Zammad will retry up to four times."
1075210752
msgstr ""
1075310753

10754-
#: ../manage/webhook.rst:10
10755-
msgid "Webhooks are sent out with the same priority and order as email triggers. If webhook dispatch fails (e.g. because the receiving server is misconfigured), Zammad will retry up to four times."
10754+
#: ../manage/webhook.rst:14
10755+
msgid "Webhooks have to be triggered by :doc:`/manage/trigger` or :doc:`/manage/scheduler` jobs."
1075610756
msgstr ""
1075710757

1075810758
#: ../manage/webhook.rst:16
10759-
msgid "Webhooks are available for :doc:`/manage/trigger` and :doc:`/manage/scheduler`."
10759+
msgid "The usage of variables is limited compared to other places. Some features are not available in webhooks (e.g. the ``.value`` extension, translation (``#{t(object.attribute)}``) and time formatting (``#{dt(object.time_attribute, [...]``) functions)."
1076010760
msgstr ""
1076110761

10762-
#: ../manage/webhook.rst:20
10762+
#: ../manage/webhook.rst:22
1076310763
msgid "How do Webhooks Work"
1076410764
msgstr ""
1076510765

10766-
#: ../manage/webhook.rst:22
10766+
#: ../manage/webhook.rst:24
1076710767
msgid "Under the hood, Zammad sends a POST request to a third-party URL (\"API endpoint\") you specify in the New Webhook dialog. The application server behind this URL/endpoint must be configured to receive messages from Zammad and handle the provided payload accordingly."
1076810768
msgstr ""
1076910769

10770-
#: ../manage/webhook.rst:27
10770+
#: ../manage/webhook.rst:29
1077110771
msgid "Webhooks can be created both from scratch and from pre-defined templates."
1077210772
msgstr ""
1077310773

10774-
#: ../manage/webhook.rst:29
10774+
#: ../manage/webhook.rst:31
1077510775
msgid "When created from scratch, regular webhook payloads by default contain the following JSON data about new/updated tickets:"
1077610776
msgstr ""
1077710777

10778-
#: ../manage/webhook.rst:32
10778+
#: ../manage/webhook.rst:34
1077910779
msgid "ticket attributes/metadata"
1078010780
msgstr ""
1078110781

10782-
#: ../manage/webhook.rst:33
10782+
#: ../manage/webhook.rst:35
1078310783
msgid "associated article(s)"
1078410784
msgstr ""
1078510785

10786-
#: ../manage/webhook.rst:34
10786+
#: ../manage/webhook.rst:36
1078710787
msgid "associated users (e.g. article senders, owners, etc.)"
1078810788
msgstr ""
1078910789

10790-
#: ../manage/webhook.rst:35
10790+
#: ../manage/webhook.rst:37
1079110791
msgid "associated user roles"
1079210792
msgstr ""
1079310793

10794-
#: ../manage/webhook.rst:36
10794+
#: ../manage/webhook.rst:38
1079510795
msgid "associated user organizations (if applicable)"
1079610796
msgstr ""
1079710797

10798-
#: ../manage/webhook.rst:37
10798+
#: ../manage/webhook.rst:39
1079910799
msgid "associated groups"
1080010800
msgstr ""
1080110801

10802-
#: ../manage/webhook.rst:39
10802+
#: ../manage/webhook.rst:41
1080310803
msgid "On the other hand, pre-defined webhooks are designed to work with specific services, containing special payloads that these services understand."
1080410804
msgstr ""
1080510805

10806-
#: ../manage/webhook.rst:42
10806+
#: ../manage/webhook.rst:44
1080710807
msgid "In both cases, however, it is possible to further customize the webhook payload to your own needs."
1080810808
msgstr ""
1080910809

manage/webhook.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,18 @@ Webhooks are a way to integrate Zammad with other web services or applications,
55
allowing them to subscribe to live updates about tickets instead of having to
66
poll the Zammad server every *n* minutes.
77

8-
.. note:: ⌛ **Webhooks may not arrive immediately.**
9-
10-
Webhooks are sent out with the same priority and order as email triggers.
11-
If webhook dispatch fails (e.g. because the receiving server is
12-
misconfigured), Zammad will retry up to four times.
13-
148
.. hint::
159

16-
Webhooks are available for :doc:`/manage/trigger` and
17-
:doc:`/manage/scheduler`.
10+
- Webhooks may not arrive immediately. They are sent out with the same
11+
priority and order as email triggers. If webhook dispatch fails (e.g.
12+
because the receiving server is misconfigured), Zammad will retry up to
13+
four times.
14+
- Webhooks have to be triggered by :doc:`/manage/trigger` or
15+
:doc:`/manage/scheduler` jobs.
16+
- The usage of variables is limited compared to other places.
17+
Some features are not available in webhooks (e.g. the ``.value`` extension,
18+
translation (``#{t(object.attribute)}``) and time formatting
19+
(``#{dt(object.time_attribute, [...]``) functions).
1820

1921
How do Webhooks Work
2022
--------------------

0 commit comments

Comments
 (0)