Documentation

Updated: 8th June 2024

Setup

To create a subscription plan, follow these steps:

  1. Navigate to the "Subscription Plans" section within your account dashboard.
  2. Click on the "Create Plan" button to begin setting up a new plan.
  3. Fill in the relevant details for your subscription plan.
  4. Review the details to ensure accuracy and completeness.
  5. Click on the "Save" or "Create Plan" button to finalize and save the subscription plan.

By following these steps, you can easily create customized subscription plans tailored to your business's offerings and pricing structure.

Pusher is used to provide real time chat functionality to the app. Follow these steps to setup

  1. Visit the official Pusher website at Pusher. Create a new account or log in with your existing one.
  2. After logging in, you'll be presented with options to create Channels or Beams. Choose Channels to proceed.
  3. Create your first channel by following the prompts provided on the screen.
  4. Once your channel is created, click on it to access its settings.
  5. Within your channel settings, locate and select App Keys.
  6. The necessary credentials, including API keys, will be automatically generated for you to use in your website's integration with Pusher.

To ensure WhatsApp campaigns are successfully delivered, it's vital to establish a cron job that runs at intervals to dispatch these campaigns.

Cron Job URl: https://yoururl.com/campaign-send

There are several ways to run the cron job. For the purposes of this documentation, we'll highlight adding a cron job in cpanel, linux/VPS server and cronjob.org

Setting Cron Job on Cpanel
  1. Access your cPanel account using your credentials.
  2. Look for the "Cron Jobs" or "Cron Tasks" icon within the cPanel dashboard. It's usually found under the "Advanced" or "Metrics" section.
  3. Click on the "Cron Jobs" icon to proceed.
  4. Under the "Add New Cron Job" section, you'll see fields to specify the timing and command for the cron job.
  5. Set Timing: We suggest to run the cron job every 3-5 minutes.
  6. In the command field, enter the appropriate command to fetch the URL. For example:
    wget -O /dev/null https://yoururl.com/campaign-send
    curl -sS https://yoururl.com/campaign-send >/dev/null 2>&1
  7. Save Cron Job
Setting Cron Job on Linux/VPS
  1. Open your crontab for editing. You can do this by running the following command in your terminal:
    crontab -e
  2. Add the following line to your crontab to execute the URL every 3 minutes:
    */3 * * * * /usr/bin/curl -sS "https://yoururl.com/campaign-send"

    Here's a breakdown of the cron schedule:

    • */3 means "every 3 minutes."
    • * in the other fields means "every hour," "every day," "every month," and "every day of the week."
  3. Save and exit your crontab editor.
Setting Cron Job on Cronjob.org
  1. Create an account on https://console.cron-job.org/
  2. Click on create cronjob on the dashboard
  3. Enter the URL of the cron job i.e. https://yoururl.com/campaign-send and set execution schedule between 3 - 5 minutes.
  4. Click create to save the cronjob

You need to setup your mail server in order for the application to send out transactional emails to your users. We currently support three mailer methods i.e. SMTP, Mailgun and Amazon SES

Setting Up SMTP
Platform: Cpanel Shared Hosting
  • Create an email in your hosting and note down the credentials.
  • Click "Connect Device" to access required info.
  • Copy this info into the relevant fields in Swiftchats mailer settings.
Platform: Resend
Platform: SendGrid
  • Create your sendgrid account here.
  • Follow this documentation on how to setup and get the SMTP credentials fron SendGrid.
  • You also need to authenticate your domain in order to send emails as documented here
Setting Up Mailgun
  • Create your mailgun account here
  • Go through this documentation on how to get your maigun domain and secret key.
  1. Go to the Facebook for Developers website (https://developers.facebook.com/) and sign in with your Facebook account and click My Apps from the menu.
  2. Then click to "Create App" button as here elegant icons
  3. Then Choose consumer here: elegant icons
  4. Then Add App name as below, then after click to create app button: elegant icons
  5. Now, you will get app id and secret, Then you need to add this details to .env file: elegant icons
  6. If you want to upload on production then you need to specify domain as well. But, you are checking with local then you don't need to add this urls: elegant icons elegant icons

That's it! You now have your Facebook Client ID and Secret, which you can use to integrate Facebook into your application. Make sure to keep your keys and secrets safe and secure to protect your users' data.

  1. Go to the Google Cloud Console and create a new project. https://console.cloud.google.com/apis/dashboard then follow the screen below: elegant icons As you can see there is a pop-up box. Just check the Terms of service then click Agree and Continue.
  2. Then click the CREATE PROJECT to continue. elegant icons Then input your project name and organization (you can set it as No organization) then click CREATE.
    NOTE: If you have a project already you can skip the above steps. And just select your current project name created previously.
  3. After creating the project, click the credentials link on the left side menu. Then click + CREATE CREDENTIALS button. From the dropdown select OAuth client ID. elegant icons
  4. In the next screen click CONFIGURE CONSENT SCREEN. elegant icons
  5. In the next screen click, select User Type as External elegant icons
  6. If your account is new you need to finish the OAuth consent screen and provide the important details they ask for. elegant icons
  7. Once the consent is finished, go back to the Credentials page by clicking Credentials on the left menu. Then click + CREATE CREDENTIALS button & from the dropdown select OAuth client ID (Like step 3 above) elegant icons
  8. In the next screen set the following:
    • Application type = Web application
    • Authorized Javascript origins = {Your url e.g. https://yoururl.com}
    • Redirect Uri = {https://yoururl.com/google/callback}
    and then click Create and copy your Client ID and Secret from the popup box elegant icons

That's it! You now have your Google Client ID and Secret, which you can use to integrate Google into your application. Make sure to keep your keys and secrets safe and secure to protect your users' data.

You have 2 options when it comes to file storage, either having them stored locally or uploaded to an AWS S3 bucket. If you want to use AWS S3 bucket, here's a guide on how to set it up:

Step 1: How to setup a public accessible S3 bucket
Step 2: How To Get AWS Access Key & Secret ID

Navigate to Settings > General Settings and the scroll down to "Google Recaptcha, Analytics & Google Maps API Key" section and then proceed with the instructions below on how to obtain the Recaptcha Site Key and Secret Key.

How to set up Google reCAPTCHA
  1. Go to the website https://www.google.com/recaptcha/admin/create
  2. If not signed in to your Google account, you will be prompted to sign in using your Google Account
  3. When registering a new website, the form will open and you need to fill in all the details correctly then submit the form.
    • Label – Type a suitable label that co-related your site name and later remembrance.
    • reCaptcha Type – Select reCAPTCHA v3
    • Domain – Your domain
  4. After submitting the form, you will get the newly generated Site Key and Secret Key.
  5. Copy the Site Key and Secret Key to the respective fields in your Swiftchats admin panel.

Navigate to Settings > General Settings and the scroll down to "Google Recaptcha, Analytics & Google Maps API Key" section and then proceed with the instructions below on how to obtain the Google Maps API Key.

How to get Google Maps API Key
Step 1: Enable Billing
  1. To start the procedure, go to Google Maps Platform, press “Get Started”.
  2. First of all, you’ll need to enable billing. This is a required step, you won’t be able to start using Google Maps API key without it. Fill in the required personal information. NB: Please note that you won’t be charged by Google just after creating a billing account
Step 2: Create an API Key
  1. Create a new project or choose an existing one. elegant icons
  2. All your API keys will be stored on a single page. To reach it, you need to go to APIs and Services, and afterwards to Credentials. elegant icons
  3. Go to Create Credentials, and then – API key. Your API key will be created, and as soon as this, you’ll see it in a popup window. elegant icons

Reviews allow you to add feedback from your users that will be displayed on the front page of your site.

  1. Log in to your admin panel and locate the "Reviews" section.
  2. Click "Add Review."
  3. Enter user's name, position, rating (1-5 stars), review status, and feedback.
  4. Check for accuracy, then save the review.

In the Teams section of your platform, you have the ability to manage administrative users and their access levels by assigning specific roles. Follow these steps to add users and create roles:

Adding Users
  1. Navigate to the "Team" section and select "Users."
  2. Click on "Add User" to begin.
  3. Fill in the necessary user details, including their name, email address, and any other relevant information.
  4. Specify the user's role within the organization or team.
  5. Once all details are entered, click "Save" to add the user to the system.
Creating Roles
  1. To define access levels for different users, go to "Team" and select "Roles."
  2. Click on "Add Role" to create a new role.
  3. Provide a descriptive name for the role to easily identify its purpose.
  4. Determine the access levels and permissions associated with the role, such as viewing, editing, or administrative rights.
  5. After configuring the role details and access levels, click "Save" to create the role.

Go to "Settings" and select "Timezone and Currency."

  • Choose your local timezone from the dropdown menu. (By default it's set to UTC)
  • Select your preferred date and time format
  • Set your preferred currency for billing transactions.
  • Click "Save" to apply your selections.
Setting Up Stripe Tutorial
Setting Up Flutterwave Tutorial