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
  1. Menu
  2. Webhooks
  3. Webhook Payload Types
  4. Rule Payloads

SIM Card Rule Payloads

It occurs when certain rules related to the SIM have been triggered.

rule.sim_card.current_usage.triggered – occurs when SUBSCRIPTION SIM Card current usage has been changed (Listing 5.14).

Listing 5.14 – Example of rule.sim_card.current_usage.triggered Payload (JSON)

{
    "type":        "rule.sim_card.current_usage.triggered",
    "data":        {
        "rule":        {...//Rule Model},
        "sim_card":    {...//Sim Card Model}
    },
    "created_at":   {...//Date Time Model}
}

rule.sim_card.status.changed – occurs when SIM Card status has been changed. SIM Card has been activated for example (Listing 5.15).

Listing 5.15 – Example of rule.sim_card.status.changed Payload (JSON)

{
    "type":        "rule.sim_card.status.changed",
    "data":        {
        "rule":        {...//Rule Model},
        "sim_card":    {...//Sim Card Model}
    },
    "created_at":   {...//Date Time Model}
}

rule.sim_card.remaining_usage.triggered – occurs when PREPAID SIM Card remaining usage has been changed (Listing 5.16).

Listing 5.16 – Example of rule.sim_card.remaining_usage_triggered Payload (JSON)

{
    "type":        "rule.sim_card.remaining_usage.triggered",
    "data":        {
        "rule":        {...//Rule Model},
        "sim_card":    {...//Sim Card Model}
    },
    "created_at":  {...//Date Time Model}
}

rule.sim_card.imei.changed – occurs when SIM Card IMEI has been changed (Listing 5.17).

Listing 5.17 – Example of rule.sim_card.imei.changed Payload (JSON)

{
    "type":        "rule.sim_card.imei.changed",
    "data":        {
        "rule":         {...//Rule Model},
        "sim_card":     {...//Sim Card Model}
    },
    "created_at":   {...//Date Time Model}
}

rule.sim_card.date.triggered – occurs when Rule “Date Triggered” has been happened (Listing 5.18).

Listing 5.18 – Example of rule.sim_card.date.triggered Payload (JSON)

{
    "type":       "rule.sim_card.date.triggered",
    "data":       {
       "rule":        {...//Rule Model},
       "sim_card":    {...//Sim Card Model}
    },
    "created_at":  {...//Date Time Model}
}

PreviousRule PayloadsNextSIM Pools Payloads

Last updated 8 months ago