Skip to main content

DeviceProvisioningRecipeStatusUpdated

Emitted when the status of a provisioning recipe changes (e.g. Pending, Applied, Failed).

Payload

FieldTypeRequiredDescription
ownerobjectOwnership 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.organizationUidstringUID of the organization that owns the event.
owner.parentCompanyUidstringUID of the owning organization's parent company.
type"Device.ProvisioningRecipeStatusUpdated" (literal)Fully-qualified event type discriminator (e.g. Device.DeviceConnectionAdded).
originatorobjectActor that initiated the action behind this event. Omitted for system-triggered events.
originator.accountIdnumberNumeric identifier of the account that initiated the action.
originator.organizationUidstringOrganization on whose behalf the action was initiated.
originator.policyUidstringPolicy under which the action was initiated, if applicable.
uidstringUnique identifier of the provisioning recipe.
deviceIdentityHashstringServer-generated unique identifier of the device, used as the public-facing identifier in the REST API.
status"Pending" | "Applied" | "Failed" | "Invalid" (literal)New provisioning status of the recipe.

Example

{
"id": "string",
"kind": "domain",
"type": "Device.ProvisioningRecipeStatusUpdated",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "59274011xxxxxxxxxxxxxxxx3eabe3ab",
"parentCompanyUid": "83392ff3xxxxxxxxxxxxxxxxb40891bd"
},
"type": "Device.ProvisioningRecipeStatusUpdated",
"originator": {
"accountId": 5783,
"organizationUid": "5cee5c1dxxxxxxxxxxxxxxxx43dfb210",
"policyUid": "4d6c15f6xxxxxxxxxxxxxxxx09c94a15"
},
"uid": "48a3aa3dxxxxxxxxxxxxxxxxdf1199cd",
"deviceIdentityHash": "b4e9f99bxxxxxxxxxxxxxxxx3e240d37",
"status": "Pending"
}
}

Shape

{
"id": "string",
"kind": "domain",
"type": "Device.ProvisioningRecipeStatusUpdated",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "string",
"parentCompanyUid": "string"
},
"type": "Device.ProvisioningRecipeStatusUpdated",
"originator?": {
"accountId?": "number",
"organizationUid?": "string",
"policyUid?": "string"
},
"uid": "string",
"deviceIdentityHash": "string",
"status": "Pending | Applied | Failed | Invalid"
}
}