Integrations Guide

Integrations allow your platform to connect with external services and add-on functionalities. This guide explains how to configure add-ons once they are enabled, without covering detailed usage or outcomes.

1. Overview

Once an add-on is activated, it often requires additional configuration to connect with external systems or services. Examples of add-ons requiring configuration include:

• Email Add-on – requires SMTP or service credentials
• SMS Add-on – requires API keys for the SMS provider
• Payment Gateway Add-on – requires API token, secret key, or merchant credentials

Proper configuration ensures the add-on is connected and ready to interact with modules, routes, hooks/actions, or schedules.

2. Configuring Add-ons

1. Email Add-on

   1. Enable the Email Add-on from the Add-ons panel.
   2. Navigate to the Add-on Configuration section.
   3. Provide required credentials:
      • SMTP Host
      • SMTP Port
      • Username
      • Password or API Key
   4. Save changes to activate the configuration.

   Once configured, the add-on is ready for modules or hooks/actions that need email functionality.

   ---

2. SMS Add-on

   1. Enable the SMS Add-on from the Add-ons panel.
   2. Open the Add-on Configuration.
   3. Enter the required API credentials provided by the SMS provider:
      • API Key
      • API Secret
      • Sender ID (if applicable)
   4. Save changes.

   This setup allows modules, hooks, or schedules to trigger SMS-related actions.

   ---

3. Payment Gateway Add-on

   1. Enable the Payment Gateway Add-on from the Add-ons panel.
   2. Access the Configuration Settings.
   3. Provide credentials required by the payment gateway:
      • API Token / Key
      • Secret Key
      • Merchant ID (if applicable)
   4. Save the configuration to enable secure transactions.

   After configuration, modules like checkout, subscriptions, or invoices can integrate with the payment gateway securely.

3. Best Practices

• Always enable the add-on first before configuring credentials.
• Keep API keys, tokens, and secrets secure and do not share publicly.
• Test integrations in a staging environment before enabling live transactions.
• Document configuration settings for future reference or audits.
• Review credentials periodically to ensure validity and security.

Integrations ensure your add-ons are functional and can interact with the platform’s modules, routes, hooks/actions, and schedules while maintaining security and modularity.