DeviceProvisioningRecipeCreated

Emitted when a new provisioning recipe is created for a device.

Payload

Field	Type	Required	Description
owner	object	✅	Ownership envelope identifying the company or organization that owns this event.
owner.ownershipType	"organization" (literal)	✅	Discriminator for the ownership envelope; always organization for these events.
owner.organizationUid	string	✅	UID of the organization that owns the event.
owner.parentCompanyUid	string	✅	UID of the owning organization's parent company.
type	"Device.ProvisioningRecipeCreated" (literal)	✅	Fully-qualified event type discriminator (e.g. Device.DeviceConnectionAdded).
originator	object	—	Actor that initiated the action behind this event. Omitted for system-triggered events.
originator.accountId	number	—	Numeric identifier of the account that initiated the action.
originator.organizationUid	string	—	Organization on whose behalf the action was initiated.
originator.policyUid	string	—	Policy under which the action was initiated, if applicable.
uid	string	✅	Unique identifier of the entity.
organizationUid	string	✅	Organization that owns this provisioning recipe.
status	"Pending" | "Applied" | "Failed" | "Invalid" (literal)	✅	Current provisioning status of the recipe.
confirmedOwnership	boolean	—	Whether device ownership has been confirmed for this recipe.
serialNumber	string	—	Serial number of the device this recipe provisions.
macAddress	string	—	MAC address of the device this recipe provisions.
model	string	—	Model of the device this recipe provisions.
brand	string	✅	Brand (manufacturer) of the device this recipe provisions.
tagUids	string[]	—	Tags to assign to the device once provisioned.
deviceName	string	—	Human-readable name to set on the device once provisioned.
policyUid	string	—	Policy to apply to the device once provisioned.
locationUid	string	—	Location to assign the device to once provisioned.
unsuccessfulRegisterAttemptStatus	object	—	Details of the most recent unsuccessful registration attempt, if any.
unsuccessfulRegisterAttemptStatus.warningMessage	string	✅	Human-readable reason the registration attempt did not succeed.
errorMessage	string	—	Error message describing why provisioning failed, if applicable.

Example

{
  "id": "string",
  "kind": "domain",
  "type": "Device.ProvisioningRecipeCreated",
  "payload": {
    "owner": {
      "ownershipType": "organization",
      "organizationUid": "f32a128cxxxxxxxxxxxxxxxxb175739b",
      "parentCompanyUid": "9a52dc0axxxxxxxxxxxxxxxx92acfccc"
    },
    "type": "Device.ProvisioningRecipeCreated",
    "originator": {
      "accountId": 2437,
      "organizationUid": "8d34290dxxxxxxxxxxxxxxxx57a00ace",
      "policyUid": "2edbe5c9xxxxxxxxxxxxxxxxe3aaca98"
    },
    "uid": "14e70f5cxxxxxxxxxxxxxxxx7620ccaf",
    "organizationUid": "624c9c67xxxxxxxxxxxxxxxxad7cd727",
    "status": "Pending",
    "confirmedOwnership": true,
    "serialNumber": "SN-749771",
    "macAddress": "29:9F:66:C8:XX:XX",
    "model": "example-model",
    "brand": "example-model",
    "tagUids": [
      "87e46004xxxxxxxxxxxxxxxx4bea2712"
    ],
    "deviceName": "Example Name",
    "policyUid": "2ca49d20xxxxxxxxxxxxxxxx56c01137",
    "locationUid": "b7cb61bfxxxxxxxxxxxxxxxxd468d313",
    "unsuccessfulRegisterAttemptStatus": {
      "warningMessage": "Something went wrong"
    },
    "errorMessage": "Something went wrong"
  }
}

Shape

{
  "id": "string",
  "kind": "domain",
  "type": "Device.ProvisioningRecipeCreated",
  "payload": {
    "owner": {
      "ownershipType": "organization",
      "organizationUid": "string",
      "parentCompanyUid": "string"
    },
    "type": "Device.ProvisioningRecipeCreated",
    "originator?": {
      "accountId?": "number",
      "organizationUid?": "string",
      "policyUid?": "string"
    },
    "uid": "string",
    "organizationUid": "string",
    "status": "Pending | Applied | Failed | Invalid",
    "confirmedOwnership?": "boolean",
    "serialNumber?": "string",
    "macAddress?": "string",
    "model?": "string",
    "brand": "string",
    "tagUids?": [
      "string"
    ],
    "deviceName?": "string",
    "policyUid?": "string",
    "locationUid?": "string",
    "unsuccessfulRegisterAttemptStatus?": {
      "warningMessage": "string"
    },
    "errorMessage?": "string"
  }
}