31
apps/docs/docs/embed/whatsapp.md
Normal file
31
apps/docs/docs/embed/whatsapp.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# WhatsApp
|
||||
|
||||
WhatsApp is currently available as a private beta test. If you'd like to try it out, reach out to support@typebot.io.
|
||||
|
||||
## Preview
|
||||
|
||||
You can preview and test your bot by clicking on the Preview button in the editor and change the runtime to "WhatsApp".
|
||||
|
||||
## Publish
|
||||
|
||||
Head over to the Share tab of your bot and click on the WhatsApp button to get the integration instructions of your bot.
|
||||
|
||||
## Limitations
|
||||
|
||||
WhatsApp environment have some limitations that you need to keep in mind when building the bot:
|
||||
|
||||
- GIF and SVG image files are not supported. They won't be displayed.
|
||||
- Buttons content can't be longer than 20 characters
|
||||
- Incompatible blocks, if present, they will be skipped:
|
||||
- Payment input block
|
||||
- Chatwoot block
|
||||
- Script block
|
||||
- Google Analytics block
|
||||
- Meta Pixel blocks
|
||||
- Execute on client options
|
||||
|
||||
## Contact information
|
||||
|
||||
You can automatically assign contact name and phone number to a variable in your bot using a Set variable block with the dedicated system values:
|
||||
|
||||
<img src="/img/whatsapp/contact-var.png" alt="WhatsApp contact system variables" />
|
||||
@@ -192,6 +192,37 @@ Used to search for images. You can create a Giphy app [here](https://unsplash.co
|
||||
| NEXT_PUBLIC_UNSPLASH_APP_NAME | | Unsplash App name |
|
||||
| NEXT_PUBLIC_UNSPLASH_ACCESS_KEY | | Unsplash API key |
|
||||
|
||||
## WhatsApp (Preview)
|
||||
|
||||
In order to be able to test your bot on WhatsApp from the Preview drawer, you need to set up a WhatsApp business app.
|
||||
|
||||
<details><summary><h4>Requirements</h4></summary>
|
||||
<p>
|
||||
|
||||
1. Make sure you have [created a WhatsApp Business Account](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started#set-up-developer-assets).
|
||||
2. Go to your [System users page](https://business.facebook.com/settings/system-users) and create a new system user that has access to the related.
|
||||
|
||||
- Token expiration: `Never`
|
||||
- Available Permissions: `whatsapp_business_messaging`, `whatsapp_business_management`
|
||||
|
||||
3. The generated token will be used as `META_SYSTEM_USER_TOKEN` in your viewer configuration.
|
||||
4. Click on `Add assets`. Under `Apps`, look for your app, select it and check `Manage app`
|
||||
5. Go to your WhatsApp Dev Console
|
||||
|
||||
<img src="/img/whatsapp/dev-console.png" alt="WhatsApp dev console" />
|
||||
|
||||
6. Add your phone number by clicking on the `Add phone number` button.
|
||||
7. Select the newly created phone number in the `From` dropdown list. This will be used as `WHATSAPP_PREVIEW_FROM_PHONE_NUMBER_ID` in your viewer configuration.
|
||||
8. Head over to `Quickstart > Configuration`. Edit the webhook URL to `$NEXT_PUBLIC_VIEWER_URL/api/v1/whatsapp/preview/webhook`. Set the Verify token to `$ENCRYPTION_SECRET` and click on `Verify and save`.
|
||||
9. Add the `messages` webhook field.
|
||||
|
||||
</p></details>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| ------------------------------------- | ------- | ------------------------------------------------------- |
|
||||
| META_SYSTEM_USER_TOKEN | | The system user token used to send WhatsApp messages |
|
||||
| WHATSAPP_PREVIEW_FROM_PHONE_NUMBER_ID | | The phone number ID from which the message will be sent |
|
||||
|
||||
## Others
|
||||
|
||||
<details><summary><h3>Show</h3></summary>
|
||||
@@ -273,10 +304,10 @@ These can also be added to the `viewer` environment
|
||||
<details><summary><h4>PostHog</h4></summary>
|
||||
<p>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| ---------------- | ------- | ---------------- |
|
||||
| POSTHOG_API_KEY | | PostHog API Key |
|
||||
| POSTHOG_API_HOST | | PostHog API Host |
|
||||
| Parameter | Default | Description |
|
||||
| ---------------------------- | ----------------------- | ---------------- |
|
||||
| NEXT_PUBLIC_POSTHOG_API_KEY | | PostHog API Key |
|
||||
| NEXT_PUBLIC_POSTHOG_API_HOST | https://app.posthog.com | PostHog API Host |
|
||||
|
||||
</p></details>
|
||||
|
||||
|
||||
BIN
apps/docs/static/img/whatsapp/contact-var.png
vendored
Normal file
BIN
apps/docs/static/img/whatsapp/contact-var.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 496 KiB |
BIN
apps/docs/static/img/whatsapp/dev-console.png
vendored
Normal file
BIN
apps/docs/static/img/whatsapp/dev-console.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 394 KiB |
Reference in New Issue
Block a user