Webhooks

Number registration events

Signed POST requests to your webhook endpoint for number-registration lifecycle events. See the Webhooks overview for signature verification.

Number Registration Completed

number-registration.completedExperimental

Triggered when the number's registration in its country's number registry completed successfully.

Payload

typestring

Optionsnumber-registration.completed

timestampstring · date-time

When the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.

dataobject

Show properties

numberRegistrationReferencestring

Opaque reference for the number registration.

profileReferencestring

esimReferencestring | null

registrystring

The registry the number was submitted to.

msisdnstring

The registered number, in international format (E.164 without a leading +).

statusstring

Optionscompletederror

reasonobject | null

Rejection detail; null unless the registration ended in error

Show properties

codestring

The registry's own rejection code, or one of ours when the registration never reached it

messagestring | null

Human-readable detail when available

number-registration.completed

{
  "type": "number-registration.completed",
  "timestamp": "2026-01-24T14:30:00Z",
  "data": {
    "numberRegistrationReference": "A1B2C3D4",
    "profileReference": "1234567890123456",
    "esimReference": "123456000000000001",
    "registry": "be_cndb",
    "msisdn": "32470123456",
    "status": "completed",
    "reason": {
      "code": "5130",
      "message": "CustomerAliasLastName is missing"
    }
  }
}

Number Registration Rejected

number-registration.rejectedExperimental

Triggered when the number's registration in its country's number registry was rejected. The data.reason carries the registry's code and message.

Payload

typestring

Optionsnumber-registration.rejected

timestampstring · date-time

When the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.

dataobject

Show properties

numberRegistrationReferencestring

Opaque reference for the number registration.

profileReferencestring

esimReferencestring | null

registrystring

The registry the number was submitted to.

msisdnstring

The registered number, in international format (E.164 without a leading +).

statusstring

Optionscompletederror

reasonobject | null

Rejection detail; null unless the registration ended in error

Show properties

codestring

The registry's own rejection code, or one of ours when the registration never reached it

messagestring | null

Human-readable detail when available

number-registration.rejected

{
  "type": "number-registration.rejected",
  "timestamp": "2026-01-24T14:30:00Z",
  "data": {
    "numberRegistrationReference": "A1B2C3D4",
    "profileReference": "1234567890123456",
    "esimReference": "123456000000000001",
    "registry": "be_cndb",
    "msisdn": "32470123456",
    "status": "completed",
    "reason": {
      "code": "5130",
      "message": "CustomerAliasLastName is missing"
    }
  }
}