Subscription created

Sent when a new subscription has been successfully created.

WEBHOOK subscription.created

Example

{
  "eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
  "type": "subscription.created",
  "occurredAt": "2023-11-07T05:31:56Z",
  "data": {
    "subscriptionId": "<string>",
    "type": "<string>",
    "display": "<string>",
    "msisdn": "<string>",
    "customer": {
      "customerId": "<string>",
      "name": "<string>"
    },
    "sim": {
      "esim": true,
      "imei": "<string>",
      "iccid": "<string>"
    },
    "activatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "referenceId": "crm-subscription-12345",
    "extensions": {},
    "pendingMsisdn": {
      "msisdn": "<string>",
      "scheduledAt": "2023-12-25"
    },
    "pendingStatus": {
      "scheduledAt": "2023-12-25"
    },
    "cancelledAt": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

apiKeybearerAuth & apiKey

X-Api-Key · string · header · required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Body

application/json

eventId · string<uuid> · required

Unique identifier for this event (stable for the logical event; multiple delivery attempts reuse the same id). Use for idempotency.

Example:

"b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab"

type · string · required

The event type identifier.

Allowed value: "subscription.created"

occurredAt · string<date-time> · required

RFC 3339 timestamp when the underlying change occurred.

data · object · required

Subscription snapshot at the time of this event.

Show child attributes

Response

200

Webhook acknowledged - no further retries will be attempted.