FAQ for Organization
  • Welcome
  • Onboarding Guide
    • Mandatory settings
      • 1. Integrate your Telecoms
      • 2. Create Company
      • 3. Upload your SIM(s)
      • 4. Create Plan(s)
      • 5. Assign the plan to SIM(s)
    • Optional settings
      • 1. Account Settings
      • 2. User Profile
      • 3. PSP Integration
      • 4. Invoice Integration
      • 5. Create Pools
      • 6. Invite Staff
      • 7. Customize Columns
      • 8. Notifications
      • 9. Communication
  • Menu
    • Roles on the platform
    • SIMs
      • SIM Statuses
      • General Terms
      • Key Features
      • Q&A
    • Satellite
      • Terminal Statuses
      • Upload Terminals
    • Pools
    • Plans
      • Prepaid
      • Subscription
      • PAYGO
    • Companies
    • End Users
    • Automation - Rules
    • Transactions
    • Wallet
    • Webhooks
      • Terms used
      • Endpoint validation
      • Authentication
      • Webhook Payload Models
        • Account Model
        • End User Model
        • Account Address Model
        • Wallet Model
        • Plan Model
        • Pool Model
        • SIM Card Model
        • Status Model
        • User Model
        • Prepaid Refill Model
        • Date Time Model
        • Rule Model
        • Payment Model
        • Credit Card Model
      • Webhook Payload Types
        • Technical Payloads
        • Event Payloads
          • Company Events
          • Company Staff Events
          • End User Events
          • SIM Card Events
          • Payment Payloads
        • Rule Payloads
          • SIM Card Rule Payloads
          • SIM Pools Payloads
          • Wallet Payloads
  • e-SIM Store
    • Upload SIMs
    • eSIM Purchase & Activation
    • eSIM Store Activation
    • Q&A
Powered by GitBook
On this page
  • Trigger list
  • Action list
  1. Menu

Automation - Rules

PreviousEnd UsersNextTransactions

Last updated 12 days ago

The Automation Rules page allows you to create and manage rules that automate various processes. This functionality helps streamline operations, improve efficiency, and ensure that specific actions are triggered automatically based on predefined criteria.

Rules are used to automate processes and consist of the following components:

  • Rule Type

  • Trigger

  • Period

  • Condition

  • Value

  • Actions

Each rule type comes with its own set of available triggers. Every trigger, in turn, is linked to a specific set of periods, conditions, and values. The available actions depend on the selected trigger, the account level, and user permissions.

Trigger list

Trigger
Applies to
Triggered when

Status

SIM and Satellite

the status changes to the selected value (e.g., Activate/Suspend)

IMEI

SIM only

the IMEI changes

Date

SIM and Satellite

the specific date is reached (e.g., activation date, contract end date)

Data left

Prepaid

the remaining data balance falls to or below the specified threshold

Data used

Subscription, PAYGO, Pool

total data usage reaches the defined limit

Voice used

SIM only

voice usage reaches the specified number of minutes

Funds used

PAYGO only

the user has spent the defined amount of funds

Remaining balance

Wallet only

the wallet balance drops to the specified amount or lower.

The rule should be triggered once the condition for the trigger is met. After that, it should perform all actions specified in the rule.

The rule should check the trigger immediately after assignment.

Action list

  • Change status – Change the status of the entity to the specified one

    • Suspended – Only applicable to the IMEI trigger

    • Activate/Suspended

  • Email notifications:

    • Default account email – Send a notification email to the default account email

    • Staff email – Send a notification email to the selected staff email

    • Company email– Send a notification email to the default company email

    • End user email– Send a notification email to the owner’s email

    • Custom email(s) – Sends a notification to one or more manually specified email addresses (maximum of 5).

  • Enable throttle – Sends a request to the Integrator to activate throttling (if supported by the operator).

  • Push API – Send a webhook to the specified API endpoint.

Page cover image