PyWa

https://pywa.readthedocs.io/en/latest/
Admin
PyWa is an all-in-one Python framework for building WhatsApp bots with the WhatsApp Cloud API,...
Tokens:290,484
Snippets:2,128
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### WhatsApp Client Initialization and Setup

Source: https://pywa.readthedocs.io/en/latest/content/client/overview.html

Demonstrates importing necessary modules, initializing the WhatsApp client with credentials, setting up a message handler, and starting the development server.

```python
>>> from pywa import WhatsApp, filters, types, utils
```

```python
>>> wa = WhatsApp(
...     phone_id="1234567890",
...     token="EAAJB...",
...     callback_url=utils.start_ngrok_tunnel(...),
...     verify_token="xyzxyz",
...     app_id=1234567890,
...     app_secret="41678a4f...",
... )
```

```python
>>> @wa.on_message(filters.text)
... def new_message(_: WhatsApp, msg: types.Message):
...     msg.reply("Hello from PyWa!")
```

```bash
$ pywa dev
```

--------------------------------

### Browse and download example bots

Source: https://pywa.readthedocs.io/en/latest/content/cli.html

Commands for interacting with the Pywa example gallery.

```bash
pywa new examples [name] [options]
```

```bash
# Run it with no arguments to list every available example:
pywa new examples
```

```bash
# Pass a slug to download that example (as a synchronous pywa bot by default) into ./<name>:
pywa new examples 02-order-bot
```

--------------------------------

### Download a specific async example bot

Source: https://pywa.readthedocs.io/en/latest/content/cli.html

Example of downloading a specific example bot using the async flag and a custom output directory.

```bash
# Download the async version of the OTP-verification bot into ./bots
pywa new examples 04-otp-verification --async -o ./bots
```

--------------------------------

### Install PyWa with server support

Source: https://pywa.readthedocs.io/en/latest/index.html

Use this command to install the PyWa framework along with the necessary server dependencies.

```bash
pip install -U "pywa[server]"
```

--------------------------------

### Start Webhook Server

Source: https://pywa.readthedocs.io/en/latest/index.html

Commands to start the webhook server for local development or production.

```bash
pywa dev    # Local development
pywa run    # Production
```

--------------------------------

### NavigationList component example

Source: https://pywa.readthedocs.io/en/latest/content/flows/flow_json.html

An example of initializing a NavigationList with a NavigationItem containing main content, start image, end details, a badge, and an on_click_action.

```python
>>> NavigationList(
...     name="navigation_list",
...     list_items=[
...         NavigationItem(
...             id="1",
...             main_content=NavigationItemMainContent(
...                 title="Title 1", description="Description 1"
...             ),
...             start=NavigationItemStart(image="base64image..."),
...             end=NavigationItemEnd(title="$100", description="/ month"),
...             badge="New",
...             on_click_action=NavigateAction(next=Next(name="SCREEN_1")),
...         ),
...         ...,
...     ],
... )
```

--------------------------------

### Install Pywa with server extras

Source: https://pywa.readthedocs.io/en/latest/content/cli.html

Install the package with the server extras to enable the run and dev commands.

```bash
pip install "pywa[server]"
```

--------------------------------

### Install pywa with server support

Source: https://pywa.readthedocs.io/en/latest/content/getting-started.html

Installation command including dependencies for webhook features.

```bash
pip3 install -U "pywa[server]"
```

--------------------------------

### Install pywa from source

Source: https://pywa.readthedocs.io/en/latest/content/getting-started.html

Installation command for the latest bleeding-edge version from the GitHub repository.

```bash
git clone https://github.com/david-lev/pywa.git
cd pywa && pip3 install -U .
```

--------------------------------

### Start Built-in Server with WhatsApp.run()

Source: https://pywa.readthedocs.io/en/latest/content/handlers/overview.html

Start the blocking built-in server directly from a Python script for prototypes.

```python
from pywa import WhatsApp

wa = WhatsApp(...)

# Register handlers here

wa.run()
```

--------------------------------

### Synchronous WhatsApp Client Example

Source: https://pywa.readthedocs.io/en/latest/content/client/overview.html

Example of initializing a synchronous WhatsApp client and handling incoming messages.

```python
from pywa import WhatsApp, types
wa = WhatsApp(...)

@wa.on_message
def on_message(_: WhatsApp, msg: types.Message):
    msg.reply("Hello!")
```

--------------------------------

### Asynchronous WhatsApp Client Example

Source: https://pywa.readthedocs.io/en/latest/content/client/overview.html

Example of initializing an asynchronous WhatsApp client and handling incoming messages using async/await.

```python
from pywa_async import WhatsApp, types
wa = WhatsApp(...)

@wa.on_message
async def on_message(_: WhatsApp, msg: types.Message):
    await msg.reply("Hello!")
```

--------------------------------

### Initialize HeaderProduct

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Example of initializing a HeaderProduct component and setting its parameters.

```python
>>> header_product = HeaderProduct()
>>> header_product.params(catalog_id="1234567890", sku="SKU12345")
```

--------------------------------

### Initialize HeaderGIF

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Example of initializing a HeaderGIF component and setting its parameters.

```python
>>> header_gif = HeaderGIF(example="https://example.com/animation.gif")
>>> header_gif.params(gif="https://cdn.com/animation.gif")
```

--------------------------------

### Dropdown Component Example

Source: https://pywa.readthedocs.io/en/latest/content/flows/flow_json.html

An example of initializing a Dropdown component with a data source, label, and required status.

```python
>>> Dropdown(
...     name="options",
...     data_source=[
...         DataSource(id="1", title="Option 1"),
...         DataSource(id="2", title="Option 2"),
...         DataSource(id="3", title="Option 3"),
...     ],
...     label="Options",
...     required=True,
...     init_value="1",
... )
```

--------------------------------

### Initialize HeaderDocument

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Example of initializing a HeaderDocument component and setting its parameters.

```python
>>> header_document = HeaderDocument(example="https://example.com/document.pdf")
>>> header_document.params(document="https://cdn.com/document.pdf")
```

--------------------------------

### DocumentPicker Component Example

Source: https://pywa.readthedocs.io/en/latest/content/flows/flow_json.html

An example of initializing a DocumentPicker component with specific constraints for file size, quantity, and allowed MIME types.

```python
>>> DocumentPicker(
...     name="document",
...     label="Upload your Driving License",
...     description="We need your document for verification",
...     max_file_size_kb=5_000,  # 5MB
...     min_uploaded_documents=1,
...     max_uploaded_documents=1,
...     allowed_mime_types=["application/pdf", "image/jpeg", "image/png"],
... )
```

--------------------------------

### Send media messages examples

Source: https://pywa.readthedocs.io/en/latest/content/cli.html

Examples of sending a document, a video from a URL, and an image using a Meta Media ID.

```bash
# Send a document with a caption and filename
pywa send document ./receipt.pdf --caption "Your Receipt" --filename "Receipt-1002.pdf" --to 1234567890

# Send a video from a URL
pywa send video https://example.com/movie.mp4 --caption "Watch this!" --to 1234567890

# Send an image using its Meta Media ID
pywa send image 987654321012345 --caption "ID image" --to 1234567890
```

--------------------------------

### WhatsApp.run

Source: https://pywa.readthedocs.io/en/latest/content/client/client_reference.html

Starts a local server to listen for incoming webhooks.

```APIDOC
## WhatsApp.run(*, host='127.0.0.1', port=8000, log_level='info')

### Description
Run the server to listen for incoming webhooks. This method starts a basic, blocking server for quick prototyping and testing.

### Parameters
- **host** (str) - Optional - The host address.
- **port** (int) - Optional - The port number.
- **log_level** (str) - Optional - The logging level.
```

--------------------------------

### Initialize HeaderLocation

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Example of initializing a HeaderLocation component and setting its parameters.

```python
>>> header_location = HeaderLocation()
>>> header_location.params(
...     lat=37.7749,
...     lon=-122.4194,
...     name="San Francisco",
...     address="California, USA",
... )
```

--------------------------------

### Build and serve documentation locally

Source: https://pywa.readthedocs.io/en/latest/content/contributing.html

Build the documentation and start a local server to preview changes.

```bash
make -C docs html
```

```bash
python3 -m http.server 8000 -d docs/build/html
```

--------------------------------

### Start ngrok Tunnel for Local Development

Source: https://pywa.readthedocs.io/en/latest/content/types/others.html

Initializes an ngrok tunnel to expose a local server to the internet. Requires the ngrok package installed via pip.

```python
>>> from pywa.utils import start_ngrok_tunnel
>>> from pywa import WhatsApp
```

```python
>>> callback_url = start_ngrok_tunnel(
...     auth_token="your_ngrok_auth_token",  # https://dashboard.ngrok.com/get-started/your-authtoken
...     domain="subdomain.ngrok-free.app",  # https://dashboard.ngrok.com/domains
... )
```

```python
>>> wa = WhatsApp(callback_url=callback_url, ...) # when using a static domain, you can comment out the callback_url parameter after the first run to avoid unnecessary webhook re-registration every time you restart the server.
```

--------------------------------

### Complete Flow Implementation

Source: https://pywa.readthedocs.io/en/latest/content/examples/sign_up_flow.html

A consolidated example showing the full structure of the sign-up flow including all imports and screen definitions.

```python
  1from pywa import utils
  2from pywa.types.flows import (
  3    FlowJSON,
  4    Screen,
  5    ScreenData,
  6    Form,
  7    Footer,
  8    Layout,
  9    Action,
 10    Next,
 11    NextType,
 12    FlowActionType,
 13    ComponentRef,
 14    InputType,
 15    TextHeading,
 16    TextSubheading,
 17    TextInput,
 18    OptIn,
 19    EmbeddedLink,
 20)
 21
 22SIGN_UP_FLOW_JSON = FlowJSON(
 23    version=utils.Version.FLOW_JSON,
 24    data_api_version=utils.Version.FLOW_DATA_API,
 25    routing_model={
 26        "START": ["SIGN_UP", "LOGIN"],
 27        "SIGN_UP": ["LOGIN"],
 28        "LOGIN": ["LOGIN_SUCCESS"],
 29        "LOGIN_SUCCESS": [],
 30    },
 31    screens=[
 32        Screen(
 33            id="START",
 34            title="Home",
 35            layout=Layout(
 36                children=[
 37                    TextHeading(
 38                        text="Welcome to our app",
 39                    ),
 40                    EmbeddedLink(
 41                        text="Click here to sign up",
 42                        on_click_action=Action(
 43                            name=FlowActionType.NAVIGATE,
 44                            next=Next(
 45                                type=NextType.SCREEN,
 46                                name="SIGN_UP",
 47                            ),
 48                            payload={
 49                                "first_name_initial_value": "",
 50                                "last_name_initial_value": "",
 51                                "email_initial_value": "",
 52                                "password_initial_value": "",
 53                                "confirm_password_initial_value": "",
 54                            },
 55                        ),
 56                    ),
 57                    EmbeddedLink(
 58                        text="Click here to login",
 59                        on_click_action=Action(
 60                            name=FlowActionType.NAVIGATE,
 61                            next=Next(
 62                                type=NextType.SCREEN,
 63                                name="LOGIN",
 64                            ),
```

--------------------------------

### State Visibility Boolean Example

Source: https://pywa.readthedocs.io/en/latest/content/examples/flows.html

Example boolean value for state_visibility.

```json
false
```

--------------------------------

### Define START screen in start_screen.py

Source: https://pywa.readthedocs.io/en/latest/content/examples/sign_up_flow.html

This static screen configuration defines the welcome heading and navigation links for the sign-up and login flows.

```python
START = Screen(
    id=”START”, title=”Home”, layout=Layout(
children=[
     
TextHeading(
    text=”Welcome to our app”,
), EmbeddedLink(
text=”Click here to sign up”, on_click_action=Action(
name=FlowActionType.NAVIGATE, next=Next(
type=NextType.SCREEN, name=”SIGN_UP”,
), payload={
“first_name_initial_value”: “”, “last_name_initial_value”: “”, “email_initial_value”: “”, “password_initial_value”: “”, “confirm_password_initial_value”: “”,
},
),
), EmbeddedLink(
text=”Click here to login”, on_click_action=Action(
name=FlowActionType.NAVIGATE, next=Next(
type=NextType.SCREEN, name=”LOGIN”,
), payload={
“email_initial_value”: “”, “password_initial_value”: “”,
},
),
),
]
),
)
```

--------------------------------

### Pincode Schema Example

Source: https://pywa.readthedocs.io/en/latest/content/examples/flows.html

Example array structure for the pincode property.

```json
[
  {
    "id": "M6B2A9",
    "title": "M6B2A9"
  }
]
```

--------------------------------

### States Schema Example

Source: https://pywa.readthedocs.io/en/latest/content/examples/flows.html

Example array structure for the states property.

```json
[
  {
    "id": "1",
    "title": "USA"
  }
]
```

--------------------------------

### Initialize and Configure QuickReplyButton

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Creates a quick reply button and sets its callback data and index.

```python
>>> quick_reply_button = QuickReplyButton(text="Yes, I want to subscribe!")
>>> quick_reply_button.params(callback_data="subscribe_yes", index=0)
```

--------------------------------

### Send a location message example

Source: https://pywa.readthedocs.io/en/latest/content/cli.html

Example of sending a location with a name and address.

```bash
pywa send location 37.7749 -122.4194 --name "San Francisco" --address "CA, USA" --to 1234567890
```

--------------------------------

### Initialize and populate HeaderVideo

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Shows how to define a HeaderVideo component with an example URL and populate it with specific media.

```python
>>> header_video = HeaderVideo(example="https://example.com/video.mp4")
>>> header_video.params(video="https://cdn.com/video.mp4")
```

--------------------------------

### Create Marketing and Authentication Templates

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Examples of initializing Template objects for marketing and authentication purposes with various components.

```python
from pywa.types.templates import *

my_template = Template(
    name="my_template",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        HeaderText(text="Welcome to our service!"),
        BodyText(text="Hello {{name}}, thank you for joining us!", name="John"),
        FooterText(text="Best regards, The Team"),
        Buttons(
            buttons=[
                QuickReplyButton(text="Get Started"),
                URLButton(
                    text="Visit Website", url="https://website.com?ref={{1}}"
                ),
            ]
        ),
    ],
    parameter_format=ParamFormat.NAMED,
)

auth_template = Template(
    name="auth_template",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.AUTHENTICATION,
    components=[
        AuthenticationBody(add_security_recommendation=True),
        AuthenticationFooter(code_expiration_minutes=5),
        Buttons(
            buttons=[
                OneTapOTPButton(
                    text="Autofill Code",
                    autofill_text="Autofill",
                    supported_apps=[
                        OTPSupportedApp(
                            package_name="com.example.myapp",
                            signature_hash="12345678901",
                        )
                    ],
                ),
            ]
        ),
    ],
)
```

--------------------------------

### Install pywa via pip

Source: https://pywa.readthedocs.io/en/latest/content/getting-started.html

Standard installation command for the pywa library.

```bash
pip3 install -U pywa
```

--------------------------------

### Manual Callback URL Registration Setup

Source: https://pywa.readthedocs.io/en/latest/content/handlers/overview.html

Initializes the WhatsApp client with a verify_token for manual registration in the Meta app dashboard.

```python
from pywa import WhatsApp

wa = WhatsApp(
    token="EAA...",
    verify_token="my-verify-token",
)
```

--------------------------------

### Installing ngrok package

Source: https://pywa.readthedocs.io/en/latest/content/handlers/overview.html

Command to install the ngrok dependency required for the tunnel helper.

```bash
pip install ngrok
```

--------------------------------

### Create a template from the library

Source: https://pywa.readthedocs.io/en/latest/content/templates/overview.html

Demonstrates how to initialize a WhatsApp client and create a template using a library template name.

```python
1from pywa import WhatsApp
2
3wa = WhatsApp(waba_id=..., token=...)
4
5# Define the template
6order_update = LibraryTemplate(
7    name="order_update",
8    library_template_name="order_update_no_cta_1",
9    category=TemplateCategory.UTILITY,
10    language=TemplateLanguage.ENGLISH_US,
11)
12
13# Create the template
14wa.create_template(order_update)
15# CreatedTemplate(id='...', category=TemplateCategory.UTILITY, status=TemplateStatus.PENDING)
```

--------------------------------

### Install cryptography dependencies

Source: https://pywa.readthedocs.io/en/latest/content/flows/overview.html

Install the required cryptography library for handling encrypted flow data.

```bash
pip3 install "pywa[cryptography]"
```

--------------------------------

### FlowStr dynamic string examples

Source: https://pywa.readthedocs.io/en/latest/content/flows/flow_json.html

Examples of using FlowStr for dynamic strings with variables and math expressions.

```python
>>> FlowJSON(
...     screens=[
...         Screen(
...             id='START',
...             layout=Layout(children=[
...                 age := TextInput(name='age', input_type=InputType.NUMBER),
...                 email := TextInput(name='email', input_type=InputType.EMAIL),
...                 TextHeading(text=FlowStr("Your age is {age} and your email is {email}", age=age.ref, email=email.ref), ...)
...             ])
...         )
...     ]
... )

>>> FlowJSON(
...     screens=[
...         Screen(
...             id='START',
...             layout=Layout(children=[
...                 bill := TextInput(name='bill', input_type=InputType.NUMBER),
...                 tip := TextInput(name='tip', input_type=InputType.NUMBER),
...                 TextHeading(text=FlowStr("Your total bill is {bill}", bill=bill.ref + (bill.ref * tip.ref / 100)), ...)
...             ])
...         )
...     ]
... )
```

--------------------------------

### Initialize and populate HeaderImage

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Shows how to define a HeaderImage component with an example URL and populate it with specific media.

```python
>>> header_image = HeaderImage(example="https://example.com/image.jpg")
>>> header_image.params(image="https://cdn.com/image.jpg")
```

--------------------------------

### EmbeddedLink Component Example

Source: https://pywa.readthedocs.io/en/latest/content/flows/flow_json.html

An example of initializing an EmbeddedLink component that navigates to a specific screen upon being clicked.

```python
>>> EmbeddedLink(
...     text="Sign up",
...     on_click_action=NavigateAction(
...         next=Next(name="SIGNUP_SCREEN"), payload={"data": "value"}
...     ),
... )
```

--------------------------------

### Scaffold Projects with CLI

Source: https://pywa.readthedocs.io/en/latest/index.html

Commands to generate a new project template or download official example bots.

```bash
pywa new                            # # Generate a basic echo-bot template
pywa new examples                   # List the official example bots
pywa new examples 02-order-bot      # Download one — ready to run with `pywa dev`
```

--------------------------------

### Configuring WhatsApp with ngrok tunnel

Source: https://pywa.readthedocs.io/en/latest/content/handlers/overview.html

Shows how to start an ngrok tunnel and initialize the WhatsApp client with the generated callback URL.

```python
 1from pywa import WhatsApp, filters, types, utils
 2
 3callback_url = utils.start_ngrok_tunnel(
 4    port=8000,
 5    auth_token="your-ngrok-auth-token",
 6    domain="subdomain.ngrok-free.app",
 7)
 8
 9wa = WhatsApp(
10    phone_id="1234567890",
11    token="EAA...",
12    app_id="1234567890",
13    app_secret="xxxx",
14    callback_url=callback_url,
15    verify_token="my-verify-token",
16)
17
18@wa.on_message(filters.text)
19def echo(client: WhatsApp, msg: types.Message):
20    msg.reply(msg.text)
```

--------------------------------

### Install Pywa with cryptography extras

Source: https://pywa.readthedocs.io/en/latest/content/cli.html

Install the package with the cryptography extras to support flows with automatic encryption.

```bash
pip install "pywa[cryptography]"
```

--------------------------------

### Initialize ZeroTapOTPButton

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Example of creating a ZeroTapOTPButton instance and setting its parameters for an OTP.

```python
>>> zero_tap_button = ZeroTapOTPButton(
...     text="Autofill Code",
...     autofill_text="Autofill",
...     zero_tap_terms_accepted=True,
...     supported_apps=[
...         OTPSupportedApp(
...             package_name="com.example.myapp", signature_hash="12345678901"
...         )
...     ],
... )
>>> zero_tap_button.params(otp="123456")
```

--------------------------------

### Initialize WhatsApp Client

Source: https://pywa.readthedocs.io/en/latest/content/examples/sign_up_flow.html

Configuration for the WhatsApp client instance in main.py, requiring credentials and business keys.

```python
from pywa import WhatsApp 

wa = WhatsApp(
    
phone_id=”1234567890”, token=”abcdefg”, callback_url=”https://my-server.com”, webhook_endpoint=”/webhook”, verify_token=”xyz123”, app_id=123, app_secret=”zzz”, business_private_key=open(“private.pem”).read(), business_private_key_password=”abc123”,
)
```

--------------------------------

### Client Layer Implementation Example

Source: https://pywa.readthedocs.io/en/latest/content/contributing.html

Example of a user-facing method in pywa/client.py that wraps the API layer and parses the response.

```python
def mark_message_as_read(self, message_id: str, *, sender: str | int | None = None) -> SuccessResult:
    return SuccessResult.from_dict(
        self.api.mark_message_as_read(
            phone_id=helpers.resolve_arg(wa=self, value=sender, method_arg="sender", ...),
            message_id=message_id,
        )
    )
```

--------------------------------

### API Layer Implementation Example

Source: https://pywa.readthedocs.io/en/latest/content/contributing.html

Example of a low-level HTTP method in pywa/api.py that mirrors the WhatsApp Cloud API.

```python
def mark_message_as_read(self, phone_id: str, message_id: str) -> dict[str, bool]:
    ...
    return self._request(
        method="POST",
        endpoint=f"/{phone_id}/messages",
        json={
            "messaging_product": "whatsapp",
            "status": "read",
            "message_id": message_id,
        },
    )
```

--------------------------------

### Initialize and Configure URLButton

Source: https://pywa.readthedocs.io/en/latest/content/templates/types.html

Creates a URL button and sets its parameters, including URL variables and index.

```python
>>> url_button = URLButton(
...     text="Visit Website",
...     url="https://website.com?ref={{1}}",
...     example="https://website.com?ref=template",
... )
>>> url_button.params(url_variable="example_variable", index=0)
```

--------------------------------

### CheckboxGroup component example

Source: https://pywa.readthedocs.io/en/latest/content/flows/flow_json.html

An example of initializing a CheckboxGroup component with a data source, label, selection constraints, and initial values.

```python
>>> CheckboxGroup(
...     name="options",
...     data_source=[
...         DataSource(id="1", title="Option 1"),
...         DataSource(id="2", title="Option 2"),
...         DataSource(id="3", title="Option 3"),
...     ],
...     label="Options",
...     min_selected_items=1,
...     max_selected_items=2,
...     required=True,
...     init_value=["1", "2"],
... )
```

--------------------------------

### Install pre-commit

Source: https://pywa.readthedocs.io/en/latest/content/contributing.html

Activate pre-commit hooks to maintain code quality standards.

```bash
uv run pre-commit install
```

--------------------------------

### JSON If Component Example

Source: https://pywa.readthedocs.io/en/latest/content/examples/flows.html

A JSON schema example demonstrating the 'If' component to conditionally display text based on user input.

```json
{
  "if_": {
    "version": "4.0",
    "screens": [
      {
        "data": {
          "value": {
            "type": "boolean",
            "__example__": true
          }
        },
        "id": "SCREEN",
        "layout": {
          "type": "SingleColumnLayout",
          "children": [
            {
              "type": "TextInput",
              "label": "Animal",
              "name": "animal",
              "helper-text": "Type: cat"
            },
            {
              "type": "If",
              "condition": "(${data.value} && (${form.animal} == 'cat'))",
              "then": [
                {
                  "type": "TextHeading",
                  "text": "It is a cat"
                }
              ],
              "else": [
                {
                  "type": "TextHeading",
                  "text": "It is not a cat"
                }
              ]
            },
            {
              "type": "Footer",
              "label": "Complete",
              "on-click-action": {
                "name": "complete",
                "payload": {}
              }
            }
          ]
        },
        "title": "Welcome",
        "terminal": true,
        "success": true
      }
    ]
  }
```
Tokens:
Raw