Platform Documentation

The complete step-by-step guide to deploying your Akmond Sentinel Engine.

1. How the System Works

Akmond Notify eliminates manual customer support for failed VTU transactions. It works by utilizing two core integrations:

  • The Database Connection: You give our Sentinel Engine Read-Only access to your VTU database. It scans your transaction table continuously for failures.
  • The WhatsApp BYOA Bridge: You connect a free WhatsApp API (Bring-Your-Own-API) to our platform. When the Sentinel spots a failure, it uses this bridge to drop an alert in your admin WhatsApp group.

2. Database Connection Guide

Security Best Practice

Never give Akmond your primary database password. Always create a new database user in your cPanel that only has the SELECT privilege.

Step 2.1: Prepare Your Server

  1. Log into your VTU website's cPanel.
  2. Go to MySQL Databases.
  3. Scroll down to Add New User. Create a user named yourprefix_akmond and generate a strong password.
  4. Scroll down to Add User to Database. Add the new user to your main VTU database.
  5. On the privileges screen, check ONLY the "SELECT" box. Save changes.
  6. Go back to cPanel home, click Remote MySQL, and whitelist our server IP Address (See Whitelist IPs).

Step 2.2: Map the Engine

  1. Log into your Akmond Notify Dashboard and click Remote DB Mapping.
  2. Enter your server's IP Address (Host), Database Name, and the Read-Only User credentials you just created.
  3. Once connected, scroll down to Map Transaction Table.
  4. Tell the Sentinel exactly which columns hold your data. For example, your target table might be transactions, the status column might be status, and the trigger value might be failed.
  5. Click Activate Engine Rules.

3. WhatsApp API Integration (Zero Fees)

To keep your monthly costs at exactly ₦0, we use a Bring-Your-Own-API model via Green-API.

Step 3.1: Create Your Free API Bridge

  1. Go to console.green-api.com and create a free account.
  2. Click the Create Instance button and select the Developer (Free) tier.

Step 3.2: Link Your WhatsApp Phone

Tip: We highly recommend using a dedicated business WhatsApp number, not your personal chat number.
  1. In your Green-API dashboard, click on the new "Instance" you just created.
  2. In the left-hand menu, click on QR Code.
  3. Open WhatsApp on your phone, tap the three dots (or Settings), and select Linked Devices.
  4. Tap Link a Device and scan the QR code on your computer screen. Your status will change to Authorized.

Step 3.3: Copy Your Keys

On your Green-API instance page, look for these two secure keys:

  • idInstance (e.g., 1101992345)
  • apiTokenInstance (e.g., d3b07384d11...)

Step 3.4: Find Your WhatsApp Group ID

To drop alerts into a specific admin group, the engine needs the Group's unique ID.

  1. In Green-API, look at the left menu and click on API Testing.
  2. Scroll down to Service Methods and click on getContacts.
  3. Click the Send button.
  4. A code box will appear showing all your chats. Search for the name of your VTU Alert group.
  5. Copy the ID next to it (It looks like this: 1203630234567890@g.us).

Step 3.5: Finalize in Akmond

  1. Go to your Akmond Notify Dashboard and click WhatsApp API Setup.
  2. Paste your Green-API ID, Token, and Group ID into the secure form.
  3. Click Encrypt & Connect API Infrastructure.

🎉 You are fully deployed!

The Akmond Sentinel is now actively guarding your platform. Do a test transaction to watch the alert arrive.