Skip to content

Commit c719626

Browse files
authored
Maintenance: add token generation via system user for WhatsApp
1 parent d1fa145 commit c719626

File tree

5 files changed

+41
-35
lines changed

5 files changed

+41
-35
lines changed

channels/whatsapp/preparation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ In the app dashboard, first re-open the configuration:
9191

9292
Now go to **API Setup** and choose or add a phone number.
9393

94-
.. note::
94+
.. warning::
9595
- This number may not be used in a WhatsApp app already, not even in a
9696
WhatsApp Business app.
9797
- In case you want to test it with a provided test number, additional

channels/whatsapp/setup.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,19 @@ WhatsApp Business Account ID
3131
:align: center
3232

3333
Access Token
34-
On the same **API Setup** page, you can generate a token. Follow the steps
35-
and confirm it so you finally see the token. Make sure to copy it directly
36-
because it gets displayed only once.
37-
38-
.. figure:: /images/channels/whatsapp/config-use-case-api-setup.png
39-
:alt: App dashboard shows API configuration and highlighted token generation.
40-
:align: center
34+
Enter the access token of a system user with the permission to manage the
35+
app. You can create it in the
36+
`business settings <https://business.facebook.com/settings/system-users>`_
37+
under *Users > System users*. Make sure to assign the created app to the
38+
system user ("Assign assets") and to grant admin access by enabling the
39+
**Manage app** toggle. After clicking the **Generate token** button, choose
40+
your created app, an expiration date of the token (we recommend "Never") and
41+
the permissions ``whatsapp_business_management`` and
42+
``whatsapp_business_messaging``.
43+
Be aware that you have to copy the token, it is just displayed once!
44+
45+
.. figure:: /images/channels/whatsapp/system-user-token-generation.png
46+
:alt: System user access token generation
4147

4248
App Secret
4349
Enter your app secret. You can find it in your app configuration under
-138 KB
Binary file not shown.
94.9 KB
Loading

locale/admin-docs.pot

Lines changed: 27 additions & 27 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: 2026-01-16 08:30+0100\n"
11+
"POT-Creation-Date: 2026-02-03 11:15+0100\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -5536,130 +5536,130 @@ msgstr ""
55365536
msgid "App dashboard with business account ID"
55375537
msgstr ""
55385538

5539-
#: ../channels/whatsapp/setup.rst:40
5539+
#: ../channels/whatsapp/setup.rst:46
55405540
msgid "Access Token"
55415541
msgstr ""
55425542

55435543
#: ../channels/whatsapp/setup.rst:34
5544-
msgid "On the same **API Setup** page, you can generate a token. Follow the steps and confirm it so you finally see the token. Make sure to copy it directly because it gets displayed only once."
5544+
msgid "Enter the access token of a system user with the permission to manage the app. You can create it in the `business settings <https://business.facebook.com/settings/system-users>`_ under *Users > System users*. Make sure to assign the created app to the system user (\"Assign assets\") and to grant admin access by enabling the **Manage app** toggle. After clicking the **Generate token** button, choose your created app, an expiration date of the token (we recommend \"Never\") and the permissions ``whatsapp_business_management`` and ``whatsapp_business_messaging``. Be aware that you have to copy the token, it is just displayed once!"
55455545
msgstr ""
55465546

55475547
#: ../channels/whatsapp/setup.rst:0
5548-
msgid "App dashboard shows API configuration and highlighted token generation."
5548+
msgid "System user access token generation"
55495549
msgstr ""
55505550

5551-
#: ../channels/whatsapp/setup.rst:47
5551+
#: ../channels/whatsapp/setup.rst:53
55525552
msgid "App Secret"
55535553
msgstr ""
55545554

5555-
#: ../channels/whatsapp/setup.rst:43
5555+
#: ../channels/whatsapp/setup.rst:49
55565556
msgid "Enter your app secret. You can find it in your app configuration under *App settings > Basic*. Click the **Show** button to be able to copy it."
55575557
msgstr ""
55585558

55595559
#: ../channels/whatsapp/setup.rst:0
55605560
msgid "App dashboard with app secret"
55615561
msgstr ""
55625562

5563-
#: ../channels/whatsapp/setup.rst:49
5563+
#: ../channels/whatsapp/setup.rst:55
55645564
msgid "After providing these three values, click on **Next** in Zammad. This performs a check and fetches your assigned phone number. If everything is fine, the dialog switches to the next step."
55655565
msgstr ""
55665566

5567-
#: ../channels/whatsapp/setup.rst:54
5567+
#: ../channels/whatsapp/setup.rst:60
55685568
msgid "Step 2"
55695569
msgstr ""
55705570

5571-
#: ../channels/whatsapp/setup.rst:56
5571+
#: ../channels/whatsapp/setup.rst:62
55725572
msgid "The second step is about your phone number and messaging details:"
55735573
msgstr ""
55745574

55755575
#: ../channels/whatsapp/setup.rst:None
55765576
msgid "Step 2 of adding a WhatsApp account"
55775577
msgstr ""
55785578

5579-
#: ../channels/whatsapp/setup.rst:66
5579+
#: ../channels/whatsapp/setup.rst:72
55805580
msgid "Phone Number"
55815581
msgstr ""
55825582

5583-
#: ../channels/whatsapp/setup.rst:64
5583+
#: ../channels/whatsapp/setup.rst:70
55845584
msgid "Choose the phone number you want to use for the channel. Zammad should have fetched the number which is assigned to your app. If not, your credentials from step 1 may be wrong."
55855585
msgstr ""
55865586

5587-
#: ../channels/whatsapp/setup.rst:70
5587+
#: ../channels/whatsapp/setup.rst:76
55885588
msgid "Welcome Message"
55895589
msgstr ""
55905590

5591-
#: ../channels/whatsapp/setup.rst:69
5591+
#: ../channels/whatsapp/setup.rst:75
55925592
msgid "Here you can define an optional text message which is automatically sent to your customers when the initial message is received."
55935593
msgstr ""
55945594

5595-
#: ../channels/whatsapp/setup.rst:79
5595+
#: ../channels/whatsapp/setup.rst:85
55965596
msgid "Automatic Reminders"
55975597
msgstr ""
55985598

5599-
#: ../channels/whatsapp/setup.rst:73
5599+
#: ../channels/whatsapp/setup.rst:79
56005600
msgid "Here you can control whether the automatic reminders about the customer service window are sent to the customer when the window is about to expire."
56015601
msgstr ""
56025602

5603-
#: ../channels/whatsapp/setup.rst:76
5603+
#: ../channels/whatsapp/setup.rst:82
56045604
msgid "For more information on 24-hour customer service windows, take a look at Meta's `conversation description <https://developers.facebook.com/docs/whatsapp/pricing#customer-service-windows>`_ under \"Customer Service Windows\"."
56055605
msgstr ""
56065606

5607-
#: ../channels/whatsapp/setup.rst:84
5607+
#: ../channels/whatsapp/setup.rst:90
56085608
msgid "Reminder Message"
56095609
msgstr ""
56105610

5611-
#: ../channels/whatsapp/setup.rst:82
5611+
#: ../channels/whatsapp/setup.rst:88
56125612
msgid "If you want to use a custom reminder message before the 24-hour customer service window closes, you can insert it here. Leave it empty to stay with the default message."
56135613
msgstr ""
56145614

5615-
#: ../channels/whatsapp/setup.rst:88
5615+
#: ../channels/whatsapp/setup.rst:94
56165616
#: ../misc/object-conditions/basics.rst:28
56175617
#: ../misc/object-conditions/basics.rst:139
56185618
#: ../system/integrations/checkmk/admin-panel-reference.rst:15
56195619
msgid "Group"
56205620
msgstr ""
56215621

5622-
#: ../channels/whatsapp/setup.rst:87
5622+
#: ../channels/whatsapp/setup.rst:93
56235623
msgid "Here you can define the :doc:`group </manage/groups/index>` in which the ticket should be created."
56245624
msgstr ""
56255625

5626-
#: ../channels/whatsapp/setup.rst:90
5626+
#: ../channels/whatsapp/setup.rst:96
56275627
msgid "After you are configured everything, click on **Submit**. Now the WhatsApp channel is technically created on Zammad side. However, you need to take another important step to make it work."
56285628
msgstr ""
56295629

5630-
#: ../channels/whatsapp/setup.rst:95
5630+
#: ../channels/whatsapp/setup.rst:101
56315631
msgid "Step 3"
56325632
msgstr ""
56335633

5634-
#: ../channels/whatsapp/setup.rst:97
5634+
#: ../channels/whatsapp/setup.rst:103
56355635
msgid "This third step is about telling WhatsApp where, how and what data to send."
56365636
msgstr ""
56375637

5638-
#: ../channels/whatsapp/setup.rst:99
5638+
#: ../channels/whatsapp/setup.rst:105
56395639
msgid "If you don't follow the instructions properly, your account shows up but you aren't able to receive messages (because Meta/WhatsApp doesn't know where to send them)!"
56405640
msgstr ""
56415641

56425642
#: ../channels/whatsapp/setup.rst:None
56435643
msgid "Step 3 of adding a WhatsApp account"
56445644
msgstr ""
56455645

5646-
#: ../channels/whatsapp/setup.rst:108
5646+
#: ../channels/whatsapp/setup.rst:114
56475647
msgid "Go to *Use cases > Configuration* and copy/paste the values from **Callback URL** as well as **Verify Token** from Zammad. Confirm with **Verify and save**."
56485648
msgstr ""
56495649

56505650
#: ../channels/whatsapp/setup.rst:None
56515651
msgid "Configuration section in WhatsApp app dashboard"
56525652
msgstr ""
56535653

5654-
#: ../channels/whatsapp/setup.rst:115
5654+
#: ../channels/whatsapp/setup.rst:121
56555655
msgid "Scroll down and switch on the toggle for ``messages`` under **Webhook fields**."
56565656
msgstr ""
56575657

56585658
#: ../channels/whatsapp/setup.rst:None
56595659
msgid "Select \"message\" as webhook field"
56605660
msgstr ""
56615661

5662-
#: ../channels/whatsapp/setup.rst:121
5662+
#: ../channels/whatsapp/setup.rst:127
56635663
msgid "After finishing this step, you can click on the **Finish** button in Zammad and you should now be ready to receive tickets from your WhatsApp channel!"
56645664
msgstr ""
56655665

0 commit comments

Comments
 (0)