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. Event Payloads

End User Events

End User Events are triggered by certain actions aimed at the End User or elements related to it.

end_user.added – occurs when Company or Organization adds an End User to themselves and the end user confirms registration, not only be invited (Listing 5.8).

Listing 5.8 – Example of end_user.added Payload (JSON)

{
    "type":         "end_user.added",
    "data":         {
        "end_user":     {...//End User Model}
    },
    "created_at":   {...//Date Time Model}
}

end_user.deleted – occurs when Company or Organization deletes their own End User. The end user must be registered, not only invited (Listing 5.9).

Listing 5.9 – Example of end_user.deleted Payload (JSON)

{
    "type":         "end_user.deleted",
    "data":         {
        "end_user":     {...//End User Model}
    },
    "created_at":   {...//Date Time Model}
}

end_user.updated – occurs when certain data is updated in an organization's/company’s End User, such as a name or email, for example (Listing 5.10).

Listing 5.10 – Example of end_user.updated Payload (JSON)

{
    "type":          "end_user.updated",
    "data":          {
        "end_user":      {...//End User Model}
    },
    "created_at":    {...//Date Time Model}
}
PreviousCompany Staff EventsNextSIM Card Events

Last updated 8 months ago