SIM Profile Activation Webhooks
What's New
To keep partners informed as a SIM profile is activated, we are introducing new webhook event types for SIM profiles:
sim_profile.enabled: Triggered when a SIM profile is enabled on the device. The device reports the enablement, and not every device or OS sends it.sim_profile.registration.completed: Triggered each time a SIM profile's network registration is updated, including its first registration.
Both events send the SIM profile as data.sim_profile and the Subscription it belongs to as data.subscription, as GET /sim-profiles/{sim-id} and GET /subscriptions/{subscription-id} return them.
SIM profiles also return their latest network registration as registration, absent until the SIM profile first registers on a network. This includes the SIM profile embedded in a Subscription and in an Order's Subscription.
Changes
Webhooks
| Webhook | Change | Description |
|---|---|---|
sim_profile.enabled | + Added | SIM profile enabled on the device |
sim_profile.registration.completed | + Added | SIM profile network registration updated |
Fields
| Fields | Change | Resources or Endpoints |
|---|---|---|
registration | + Added (optional) | SIM Profile: GET /sim-profiles/{sim-id}, sim_profile.enabled, sim_profile.registration.completed |
_embedded.sim_profile.registration | + Added (optional) | Subscription: GET /subscriptions/{subscription-id} and every payload that carries a Subscription |
_embedded.subscription._embedded.sim_profile.registration | + Added (optional) | Order: GET /orders/{order-id} and every payload that carries an Order |
registration.country | + Added | Wherever registration is returned |
registration.registered_at | + Added | Wherever registration is returned |