Skip to content

External services

Applies to: developers and DriveFlow operations; Owner and Administrator for background. Last reviewed: 2026-11-18.

This page lists every outside service the DriveFlow API talks to, what it is used for, who configures it, and what happens when it is not configured. It is based on the service registrations in the API's start-up code and the classes in the Infrastructure project.

Note

No secret values or server configuration details are given here. Server set-up is covered in the internal technical documentation.

Overview

Service Used for Configured by If not configured
PayFast Subscription payments; students paying school invoices DriveFlow (own account) and each school (own account, under Settings > Payments) Checkout fails: "PayFast is not configured." / online payments unavailable to students
SMTP email All email DriveFlow (global account); each school optionally (own account, under Settings > Email) Sending fails; recorded as Failed
Vodacom Messaging SMS notifications DriveFlow Nothing is sent (see note)
Meta WhatsApp Cloud API WhatsApp notifications DriveFlow Nothing is sent (see note)
Meta Graph API (Facebook) Connecting a Facebook Page, receiving lead ads DriveFlow (app); each school connects its Page Connecting fails; no leads arrive
Firebase Cloud Messaging Push notifications to the mobile app DriveFlow Push is off
QuestPDF (library, in-process) PDF documents Nothing to configure -
Hangfire (library, uses the database) Background and scheduled jobs Uses the main database connection -
Local file storage Uploaded files Server disk -
Paystack, Flutterwave, Stripe Nothing in practice - Not used; see Payment gateways

Email (SMTP)

What it does. Every email DriveFlow sends goes out by SMTP: notifications to students and staff, invoices, receipts, payment reminders, quotes, welcome emails and DriveFlow's own subscription invoices.

Whose mail account is used.

  • If the school has saved its own email server settings, the school's emails are sent through the school's account.
  • If it has not, or there is no school in context (for example some background jobs), the global DriveFlow account is used.
  • DriveFlow's subscription invoices are always sent from DriveFlow's global account, never from the school's.

A school's SMTP password is stored securely.

Port 465 is not supported

Port 465 (implicit SSL) is not supported. Sending fails at once with "SMTP port 465 (implicit SSL) is not supported. Use port 587 with SSL/TLS enabled instead."

Timeout. 30 seconds per message.

The school's Email settings page and the emails themselves are described in the notifications documentation.

Unused code. Classes for SendGrid, MailKit and a plain SMTP sender exist in the Infrastructure project but are not registered; only the tenant-aware SMTP service is used.

SMS (Vodacom Messaging)

What it does. Sends SMS notifications through Vodacom's Messaging HTTP API.

Settings. DriveFlow configures the Vodacom account, sender name and related options on the server. This is covered in the internal technical documentation.

Behaviour.

  • Numbers are converted to international format before sending; a number that cannot be converted fails with "'…' is not a valid destination number."
  • A failure is recorded against the notification with the provider's message, and the SMS credits taken for it are returned.
  • With SMS switched on but the account not fully set up: "Vodacom SMS is enabled but no credentials are configured."

Disabled means \"silently not sent\"

When SMS sending is switched off on the server, the service returns without error and only writes a log line. The notification is recorded as Sent, and the school's SMS credits for it are used, although no SMS left the server. This is intended to keep test environments from calling a paid API, but it means a production server must have SMS enabled before SMS bundles are sold.

All schools share one sender. There is no per-school SMS account or sender name.

Credits and bundles: SMS bundles.

Unused code. Classes for Twilio and Azure SMS exist but are not registered.

WhatsApp (Meta WhatsApp Cloud API)

One DriveFlow-owned WhatsApp business number, configured by DriveFlow on the server. Free-form text only, with the 24-hour restriction that implies, and the same "disabled means silently not sent" behaviour as SMS. Full details: WhatsApp integration.

Facebook and Instagram (Meta Graph API)

Used to connect a school's Facebook Page (OAuth), subscribe it to lead notifications, and fetch each lead's answers. Configured by DriveFlow on the server. Full details: Meta: Facebook and Instagram.

Push notifications (Firebase Cloud Messaging)

What it does. Sends push notifications to phones signed in to DriveFlow Mobile, using the Firebase Admin SDK.

Setting. DriveFlow supplies the Firebase credentials on the server. Without them, push is simply off and everything else works.

Behaviour.

  • Push is only attempted for schools whose plan includes the mobile app.
  • A recipient with no registered phone is skipped without a warning.
  • Notification text is shortened to 240 characters.
  • Phones that Firebase no longer recognises (app removed or reinstalled) are detected so their registrations can be cleaned up.
  • Android notifications use the channel driveflow_updates.

What triggers a push and how the app registers a phone are covered in the notifications documentation and Mobile app entitlements.

PDF generation (QuestPDF)

PDFs are produced inside the API with the QuestPDF library, under its Community licence setting. Nothing external is called. The documents rendered this way are:

  • student invoices,
  • payment receipts,
  • DriveFlow's subscription invoices,
  • quotes,
  • student assessments.

PDFs are generated on demand each time they are downloaded or emailed; they are not stored.

Note

The QuestPDF Community licence has eligibility conditions set by its publisher. Whether DriveFlow's commercial use meets them is a business matter to confirm, not something the code decides.

Background jobs (Hangfire)

Scheduled and queued work runs in Hangfire, inside the API process, storing its queue in the main SQL Server database. Access to its monitoring dashboard is restricted to DriveFlow operations.

Job Schedule Purpose
lesson-reminders Every 15 minutes Lesson reminders at each school's chosen lead time
driving-test-reminders Every 15 minutes Driving test reminders
document-expiry-reminders Daily 07:00 Expiring documents
invoice-reminders Daily 08:00 Overdue and due-soon invoice reminders
subscription-expiry Hourly Marks ended trials and subscriptions as Expired
meta-lead-requeue Every 15 minutes Re-queues Facebook leads that were recorded but not imported
report-generation Daily 23:00 Report generation

In addition, each Facebook lead is imported by a queued job with up to 5 retries.

Because Hangfire runs inside the API, jobs only run while the API is running. If registering the schedules fails at start-up, the API still starts and logs the error.

There is no job that charges or renews subscriptions.

File storage

Uploaded files are stored on the API server's own disk (local file storage). Only the company-logo folder (/uploads/companies) is served publicly, so that logos can be shown in the application, in emails and on PDFs. No cloud storage service is used.

A deployment with more than one API server, or one that replaces the server's disk on each release, needs shared or persistent storage for this folder.

Encryption keys (ASP.NET Data Protection)

Not an external service, but everything above depends on it. Secrets that schools enter (SMTP password, PayFast merchant key and passphrase), the Facebook Page tokens and the Facebook connection "state" are encrypted with ASP.NET Data Protection. The keys are kept so that a new server or container can still read what an old one encrypted.

If those keys were lost, the saved secrets could not be read: schools would have to re-enter their PayFast and email details and reconnect their Facebook Page.

Platform settings

Section Setting Purpose
Platform AdminEmail Where DriveFlow's own alerts go, for example when a new school registers.
Platform AppUrl The web application's address, used for links and the logo in emails. Left empty, emails have no sign-in link.
BillingIssuer LegalName, TradingName, Address, Email, Phone, Website, RegistrationNumber, VatNumber The business printed as the issuer on subscription invoices.
BillingIssuer VatRegistered, VatRate Whether subscription invoices show VAT, and at what rate. See Billing invoices.

Outbound connections: checklist for hosting

The API server must be able to reach:

  • PayFast (live or sandbox) - to confirm payment notifications,
  • graph.facebook.com - Facebook leads and WhatsApp,
  • the Vodacom Messaging address,
  • Firebase / Google APIs,
  • the SMTP servers in use (DriveFlow's and any school's), on port 587 or another STARTTLS port.

And the internet must be able to reach the API at its PayFast payment-notification addresses (subscription and student payments) and its Meta webhook and Facebook callback addresses. The exact addresses are covered in the internal technical documentation.

Limitations and notes

  • SMS and WhatsApp report Sent when their server switch is off. Check the server configuration before relying on the notification history.
  • No accounting package, calendar service, mapping service or single sign-on provider is integrated, despite "Accounting Integration" and "API Access" appearing as Enterprise plan features.
  • No error-monitoring or analytics service registration was found in the API's start-up code.
  • Email delivery is "handed to the SMTP server", not "delivered". Bounces are not tracked.
  • The DriveFlow.Web project's own start-up code was not examined for this page; it talks to the API rather than to outside services.