Creating Workspace

After subscribing to a plan, you must create a Workspace for your business.

What is Workspace?

A Workspace provides:

• Isolated Environment: Separate from other businesses
• Unique Subdomain: Access via https://[subdomain].awalchat.com
• Independent Settings: Custom configurations per business
• Secure Access: Protected by authentication
• API Integration: Connect external applications

1. Accessing Workspace Page

Prerequisites

Before accessing the Workspace page, you must have:

• ✅ Active Subscription to a plan
• ✅ Business account created

From Dashboard

1. From the business page, navigate to the "Workspace" section or "Setup Workspace"
2. If you don't have a subscription, you'll see a message with two options:
   • "Subscribe Now": Navigate to pricing page
   • "Subscribe to Free Plan": Subscribe to the free plan
3. After subscription, the Workspace setup page will appear

2. Workspace Setup Process

The Workspace page displays a multi-step setup process using a Steps system:

Overview of Steps

1. Domain Setup: Configure subdomain
2. User Data: Set up email and password
3. Security Settings: Configure HmacSecret
4. Installation & Removal: Install or uninstall Workspace

Navigating Between Steps

• Use "Previous Step" and "Next Step" buttons to navigate
• Or click on any quick navigation card to jump directly to the desired step
• You can navigate freely between steps before installation

3. Step 1: Domain Setup

Setting Up Subdomain

1. In the first step, you'll find the "Domain Setup" card
2. If you have an existing domain, the current domain will be displayed with "Copy" and "Share" buttons
3. Click "Edit" to modify the domain

Entering Domain Name

1. In the popup modal, enter the subdomain name
2. Requirements:
   • Must be unique across the platform
   • Can only contain lowercase letters (a-z)
   • Can contain numbers (0-9)
   • Can contain hyphens (-)
   • Cannot start or end with a hyphen
   • Minimum: 3 characters
   • Maximum: 63 characters
3. Domain availability will be checked automatically as you type
4. The full domain will be: https://[username].awalchat.com

Business UUID

• If available, Business UUID will be displayed in the domain card
• You can copy the UUID for use in integrations

4. Step 2: User Data

Setting Up Login Credentials

1. In the second step, you'll find the "User Data" card
2. Enter the following information:

Email

• Requirements:
  • Must be a valid email address
  • Used for logging into Workspace
• Can be changed: Yes, from Workspace settings

Password

• Requirements:
  • Minimum: 6 characters
  • Strong password recommended
• Can be changed: Yes, from Workspace settings

3. Click "Save" to save the data

5. Step 3: Security Settings

Configuring HmacSecret

1. In the third step, you'll find the "Security Settings" card
2. HmacSecret is a security key used for:
   • API authentication
   • Webhook verification
   • Secure external integrations

Generating HmacSecret

1. If you don't have an HmacSecret, click the "Generate" button (Reload icon)
2. A new key will be generated automatically
3. Or you can enter a custom key

Saving HmacSecret

Viewing and Copying HmacSecret

• Click the eye icon to view the key
• Click the copy icon to copy the key
• You can open a modal to view the full key

HmacSecret Requirements

• Minimum: 32 characters
• Format: Can contain letters, numbers, and symbols

6. Step 4: Installation & Removal

Workspace Status

Before installation, check the Workspace status:

• Ready: Ready for installation
• Installed: Installed but not active
• Active: Active and running
• Stopped: Stopped

Installing Workspace

1. If status is "Ready", you'll see the "Installation & Removal" card
2. Click the "Install" button
3. A confirmation modal will appear
4. Click "Confirm" to confirm installation
5. ⚠️ Important: Do not close the page during installation

Installation Process

During installation, the system:

• Creates your Workspace environment
• Sets up databases
• Configures security
• Prepares all necessary services
• Activates the subdomain

Estimated Time: 2-5 minutes

Uninstalling Workspace

1. If Workspace is installed and active, you'll see an "Uninstall" button
2. Click "Uninstall"
3. A warning confirmation modal will appear
4. ⚠️ Warning: This action cannot be undone
5. Click "Confirm" to confirm uninstallation

7. Accessing Your Workspace

After successful installation:

Link

Workspace is available at:

https://[subdomain].awalchat.com

Where [subdomain] is the domain name you entered in Step 1.

Logging In

1. Use the email and password you entered in Step 2
2. Log in to the Workspace

Access Methods

You can access your Workspace from:

• Direct Link: https://[subdomain].awalchat.com
• Dashboard: From the Workspace page, click on the link
• Workspace Management Page: From Workspace menu in dashboard

Updating Data

After installation, you can update:

• Domain: Cannot be changed after creation
• Email: From Step 2 (User Data)
• Password: From Step 2 (User Data)
• HmacSecret: From Step 3 (Security Settings) - Warning: Regenerating may break integrations

Process Flow Diagram

Start
  ↓
Check Subscription
  ↓ (Yes)
Domain Setup
  ↓
User Data Setup
  ↓
HmacSecret Setup (Security Settings)
  ↓
Check Status (Ready?)
  ↓ (Yes)
Install Workspace
  ↓
Check Status (Active?)
  ↓ (Yes)
✅ Workspace Ready to Use

Plan Comparison & Workspace Features

The following table shows Workspace features available in each plan:

Choosing the Right Plan

• Free Plan: Suitable for getting started, testing, or small projects
• Basic Plan: Suitable for small to medium businesses
• Advanced Plan: Suitable for large businesses with multiple needs
• Professional Plan: Suitable for large enterprises with high requirements

Quick Start Guide

In Just 5 Minutes! ⚡

Follow these quick steps to set up your Workspace:

Step 1: Check Subscription (30 seconds)

• Ensure you have an active subscription
• If you don't have a subscription, click "Subscribe to Free Plan"

Step 2: Domain Setup (1 minute)

• Click "Edit" in the Domain Setup card
• Enter a unique domain name (e.g., mybusiness)
• Wait for availability check
• Click "Save Changes"

Step 3: User Data Setup (1 minute)

• Enter your email address
• Enter a strong password (6+ characters)
• Click "Save"

Step 4: HmacSecret Setup (1 minute)

• Click the "Generate" button to create a new key
• ⚠️ Important: Copy the key and save it securely
• Click "Save"

Step 5: Installation (2 minutes)

• Verify status is "Ready"
• Click "Install"
• Confirm installation
• Wait for process to complete (2-5 minutes)
• ✅ Workspace is ready!

Quick Tips

💡 Domain Name: Use a short, clear name that represents your business
💡 HmacSecret: Save it immediately - you won't be able to retrieve it
💡 Password: Use a strong, unique password
💡 Installation: Don't close the page during installation

What's Next?

After setting up Workspace:

1. ✅ Connect WhatsApp: WhatsApp Integration Guide
2. ✅ Use API: API Reference
3. ✅ Manage Workspace: Return to Workspace page to update settings

Quick Access Links

Access these pages directly from your dashboard:

• ⚙️ Workspace Settings - Manage workspace (replace {businessId} with your business ID)
• 📊 Business Dashboard - Return to dashboard (replace {businessId} with your business ID)
• 📱 WhatsApp Integration - Connect WhatsApp (replace {businessId} with your business ID)

Next Steps

After successfully creating your Workspace:

👉 Connect WhatsApp

👉 API Reference - To use HmacSecret in integrations

Important Notes

Pre-Setup Checklist

Before starting Workspace setup, ensure:

• You have an active subscription to a plan
• Business account has been created
• You've chosen an appropriate domain name (cannot be changed later)
• You have a valid email address
• You've prepared a strong password
• You understand the importance of HmacSecret and will save it securely

Workspace Statuses

The following table shows all possible Workspace statuses:

Best Practices

Choosing Domain Name

• ✅ Use a short and clear name
• ✅ Avoid complex special characters
• ✅ Use a name that represents your business
• ❌ Don't use very long names
• ❌ Don't use random numbers only

Managing HmacSecret

• ✅ Save it in a password manager
• ✅ Don't share it with anyone
• ✅ Don't put it in source code
• ✅ Use it only in secure integrations
• ❌ Don't regenerate it unless absolutely necessary

Security

• ✅ Use a strong password (8+ characters, uppercase, lowercase, numbers, symbols)
• ✅ Change password regularly
• ✅ Use a professional email address
• ✅ Don't share login credentials

Frequently Asked Questions (FAQ)

Can I change the domain name after creation?

No, the domain name cannot be changed after creation. Choose it carefully from the start.

What happens if I lose my HmacSecret?

You can regenerate HmacSecret from Step 3, but warning: this will break all existing integrations using the old key.

How long does the installation process take?

Usually takes 2-5 minutes, but may take longer during peak times.

Can I uninstall and reinstall later?

Yes, you can uninstall and reinstall later. However, be warned: uninstalling will stop all services.

Do I need Workspace to use WhatsApp Integration?

Yes, you must have an installed and active Workspace before you can manage WhatsApp numbers.

What's the difference between "Installed" and "Active"?

• Installed: Workspace is installed but may not be fully active
• Active: Workspace is active and running at full capacity

Troubleshooting

Issue: Cannot Create Workspace

Possible Causes:

• Subdomain already in use
• Invalid subdomain format
• Plan doesn't support Workspace creation
• No active subscription

Solutions:

1. Try a different subdomain name
2. Ensure subdomain follows naming rules
3. Verify your plan includes Workspace feature
4. Ensure you have an active subscription
5. Contact support if issue persists

Issue: Installation Fails

Possible Causes:

• Network connectivity issues
• Server maintenance
• Invalid configuration
• Basic steps not completed

Solutions:

1. Check your internet connection
2. Wait a few minutes and try again
3. Verify all information is correct
4. Ensure all steps are completed (Domain, User Data, HmacSecret)
5. Check Workspace status (should be "Ready")
6. Contact support with error details

Issue: Cannot Access Workspace After Installation

Possible Causes:

• Workspace installation not completed
• Incorrect login credentials
• Domain not activated yet

Solutions:

1. Check Workspace status (should be "Active")
2. Ensure you're using the correct email and password
3. Wait a few minutes after installation
4. Try clearing browser cache
5. Contact support if issue persists

Issue: HmacSecret Not Working in Integrations

Possible Causes:

• Key copied incorrectly
• Key was regenerated
• Incorrect key

Solutions:

1. Ensure the key is copied completely (no extra spaces)
2. Verify you're using the correct key (latest one)
3. Re-enter the key in the integration
4. If it fails, generate a new key (note: this may break other integrations)

Support and Help

If you encounter any issues:

• 📧 Email: support@awalchat.com
• 💬 Live Chat: Available in the dashboard
• 📱 WhatsApp: Contact us directly via WhatsApp
• 📚 Complete Guide: Review the Setup Guide