to navigate · to open See all results

Asset event setup

Configure acquisition, lifecycle, condition, and decommission event definitions through the public API.

Last updated

Event definitions

Use https://my.assetcenter.app/api/v1/asset-events to configure the events offered by your organization: acquisition, lifecycle, condition, and decommission. Definitions include appearance, availability, category restrictions, fields, and display ordering.

To record something that happened to an asset, use asset lifecycle events, acquisitions, condition changes, or decommissioning. Read recorded history through asset timelines.

Endpoints and permissions

Action Endpoint Permission
List definitions GET /api/v1/asset-events asset-events:read
Get a definition and fields GET /api/v1/asset-events/{event} asset-events:read
Get setup options GET /api/v1/asset-events/options asset-events:read
Create a definition POST /api/v1/asset-events asset-events:create
Update a definition and fields PATCH /api/v1/asset-events/{event} asset-events:update
Delete an unused custom definition DELETE /api/v1/asset-events/{event} asset-events:delete
Change display order PUT /api/v1/asset-events/{event}/position asset-events:update

The token fixes the organization, regardless of its creator’s selected account. Its creator must remain an active administrator. These permissions are independent of asset-record permissions. New Read Only keys include asset-events:read; new Full Access keys include all four event permissions. Custom keys can select each separately. Existing keys keep their current permissions; create a replacement key to grant the new access.

Shared defaults and history

Lists include organization definitions and shared defaults that the organization has not overridden. Hidden definitions are included unless filtered out. Updating a shared default creates an organization-specific copy with new event and field IDs. The original shared definition and saved history remain intact. Use the returned IDs for subsequent requests. Reordering also localizes shared defaults in the affected group; refresh that group afterward.

System events, shared defaults, overrides, and definitions referenced by current asset conditions, acquisitions, decommissioning, or event history cannot be deleted. History checks include drafts and archived assets. Set visible to false instead. Fields with saved values cannot be removed or change datatype; hide them with visible: false. Field metadata for shared defaults reports usage only in the token’s organization.

PATCH changes only supplied properties. Omitting fields preserves them; supplying fields replaces the complete field list in array order. Existing field IDs and slugs must be retained. An empty list removes all removable fields. Read-only metadata is rejected in writes.

Every write requires Idempotency-Key, with successful responses replayable for 24 hours. Replay works even when a shared ID has been replaced or an event was deleted; a fresh request to a replaced ID returns 404.