Download OpenAPI specification:Download
Tourfold is a comprehensive SaaS platform for field service management. Our API provides programmatic access to manage jobs, tours, users and much more.
Use the endpoints documented here to automate dispatching flows, synchronize your account data, and build custom integrations for your operators and mobile clients.
Request and response examples follow Alpine Facility Services GmbH, a fictional Vienna maintenance company. The example identities are illustrative and are not created automatically in customer workspaces.
For detailed documentation, workflow guides, and onboarding support, visit https://docs.tourfold.com.
Returns the tenant billing profile used for invoices and Stripe customer metadata.
AlpineBillingProfile
{- "billing_full_name": "Mara Berger",
- "billing_business_name": "Alpine Facility Services GmbH",
- "billing_vat_number": "ATU12345678",
- "billing_country_code": "AT",
- "billing_email": "billing@example.invalid",
- "billing_address_line1": "Riverside Office 17",
- "billing_city": "Vienna",
- "billing_postal_code": "1210",
- "billing_state_province": "Vienna",
- "lock_version": 0
}JSON Merge Patch (RFC 7386): omitted fields remain unchanged; a field set to null is cleared. Fields required for invoicing (billing_email, billing_address_line1, billing_city, billing_postal_code, billing_country_code, and a full name or business name) cannot be cleared โ explicit null on those is rejected with 422. Updates the tenant billing profile and syncs supported fields to Stripe when the tenant has a Stripe customer.
| billing_full_name | string or null Billing contact full name. Omitted leaves the value unchanged; explicit null clears it, but a business name must then be present (a full name or business name is required for invoicing). |
| billing_business_name | string or null Billing business name. Omitted leaves the value unchanged; explicit null clears it, but a full name must then be present (a full name or business name is required for invoicing). |
| billing_vat_number | string or null VAT number. Read-only after signup โ contact support to change. Omitted leaves the value unchanged; explicit null clears it. |
| billing_country_code | string or null ISO 3166-1 alpha-2 billing country code. Read-only after signup โ contact support to change. Required for invoicing: omitted leaves the value unchanged; explicit null is rejected with 422. |
| billing_email | string or null Email address that receives PDF invoices. Required for invoicing: omitted leaves the value unchanged; explicit null is rejected with 422. |
| billing_address_line1 | string or null Street address, first line. Required for invoicing: omitted leaves the value unchanged; explicit null is rejected with 422. |
| billing_address_line2 | string or null Street address, second line. Omitted leaves the value unchanged; explicit null clears it. |
| billing_city | string or null City. Required for invoicing: omitted leaves the value unchanged; explicit null is rejected with 422. |
| billing_postal_code | string or null Postal code. Required for invoicing: omitted leaves the value unchanged; explicit null is rejected with 422. |
| billing_state_province | string or null State / province / region. Omitted leaves the value unchanged; explicit null clears it. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch) if a profile already exists; omitting it skips the concurrency check. Ignored when creating the first profile. |
UpdateBillingProfileNull
{- "billing_address_line2": null,
- "billing_city": "Vienna",
- "lock_version": 0
}UpdatedAlpineBillingProfile
{- "billing_full_name": "Mara Berger",
- "billing_business_name": "Alpine Facility Services GmbH",
- "billing_vat_number": "ATU12345678",
- "billing_country_code": "AT",
- "billing_email": "billing@example.invalid",
- "billing_address_line1": "Riverside Office 17",
- "billing_city": "Vienna",
- "billing_postal_code": "1210",
- "billing_state_province": "Vienna",
- "lock_version": 0
}Returns the object's class-level access-control entries (per role/user/everyone). Requires the objects:configuration:read grant plus, per object, the objects:configuration:edit-permissions grant or ownership. Only protected objects have a matrix (readOnly objects return 422).
| object_ref required | string Object slug or UUID id. |
EquipmentPermissions
{- "object_slug": "equipment",
- "entries": [
- {
- "principal_type": "everyone",
- "level": "read"
}, - {
- "principal_type": "role",
- "role_name": "field_technician",
- "level": "write"
}
]
}Stores the supplied entries as the object's complete class-level matrix โ a whole-set declarative replace, not a merge; {"entries":[]} clears the matrix. Requires the objects:configuration:read grant plus, per object, the objects:configuration:edit-permissions grant or ownership.
| object_ref required | string Object slug or UUID id. |
required | Array of objects (ObjectPermissionEntryInput) The complete list of entries the type should have after this call. | ||||||||
Array
| |||||||||
ReplaceEquipmentPermissions
{- "entries": [
- {
- "principal_type": "everyone",
- "level": "read"
}, - {
- "principal_type": "role",
- "role_name": "field_technician",
- "level": "write"
}
]
}ReplacedEquipmentPermissions
{- "object_slug": "equipment",
- "entries": [
- {
- "principal_type": "everyone",
- "level": "read"
}, - {
- "principal_type": "role",
- "role_name": "field_technician",
- "level": "write"
}
]
}Replaces the tags assigned to a user. Empty tag_ids removes all assigned tags.
| user_id required | string <uuid> UUID of the user. |
| tag_ids required | Array of strings <uuid> unique [ items <uuid > ] Tag IDs to assign to the user. Empty array removes all assigned tags. |
| lock_version | integer or null <int64> Optimistic locking version of the user aggregate; validated when provided (409 on mismatch), omitting it skips the concurrency check |
ReplaceWithUrgentTag
{- "tag_ids": [
- "00000000-0000-4000-8000-000000005001"
], - "lock_version": 0
}JonasWithReplacedTags
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Returns the skills assigned to a user.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user whose skills should be retrieved |
JonasSkills
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
]
}Replaces the skills assigned to a user. Empty skill_ids removes all assigned skills.
| user_id required | string <uuid> UUID of the user. |
| skill_ids required | Array of strings <uuid> unique [ items <uuid > ] Skill IDs to assign to the user. Empty array removes all assigned skills. |
| lock_version | integer or null <int64> Optimistic locking version of the user aggregate; validated when provided (409 on mismatch), omitting it skips the concurrency check |
ReplaceWithHvacSkill
{- "skill_ids": [
- "00000000-0000-4000-8000-000000006001"
], - "lock_version": 0
}JonasWithReplacedSkills
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Returns a paginated list of users in your account. Service accounts and API-only users are excluded.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
| sort | Array of strings Example: sort=last_name:asc Repeated sorting criteria in |
| search | string Search term for email, first name, or last name. |
| role | string Example: role=driver Filter by role name. Matching is case-insensitive. |
| status | string Default: "ACTIVE" Enum: "ACTIVE" "BLOCKED" "INACTIVE" "ALL" Filter by user status (ACTIVE, BLOCKED, INACTIVE, ALL). Default is ACTIVE. |
| role_ids | Array of strings <uuid> [ items <uuid > ] Filter users by one or more role UUIDs. Only users assigned to at least one of the specified roles are returned. |
| skill_ids | Array of strings <uuid> [ items <uuid > ] Filter users by one or more skill UUIDs. Only users with at least one of the specified skill offerings are returned. |
| tag_names | Array of strings Filter users by tag name (OR semantics: returns users that have at least one of the given tags). Multiple values are supported. When omitted, no tag filtering is applied. |
| updated_from | string <date-time> Example: updated_from=2024-01-01T00:00:00Z Lower bound for |
| updated_to | string <date-time> Example: updated_to=2024-12-31T23:59:59Z Upper bound for |
UsersResponse
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000001001",
- "email": "mara.berger@example.invalid",
- "phone_number": "+436601234567",
- "roles": [
- "dispatcher"
], - "skills": [ ],
- "firstname": "Mara",
- "lastname": "Berger",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T08:00:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [ ]
}, - {
- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}
], - "page": {
- "size": 2,
- "total_elements": 2,
- "total_pages": 1,
- "number": 0
}
}Creates a user and assigns roles permitted for the caller. Owner-role assignment requires the ownership transfer operation. Email is immutable after creation. Where the workspace manages its people's profiles, firstname and lastname are required and phone_number is optional. Where people manage their own profile (one sign-in account for all their workspaces; is_profile_self_managed on their users), this invites the person by email and the request must not carry firstname, lastname or phone_number: the user has no name until the person's first sign-in (profile_status PENDING), whether or not they already have a Tourfold account. A person new to Tourfold gets an invitation email; a person who already has an account gets an email saying they were added.
| Origin | string |
| email required | string <email> non-empty Email address of the user |
| firstname | string First name of the user. Required where the workspace manages its people's profiles. Where people manage their own profile (one sign-in account for all their workspaces; is_profile_self_managed on their users) it must be omitted: the person enters it at first sign-in, and sending it is rejected with 422, problem type users/profile-self-managed. A blank value is rejected. Cannot contain < > & " $ % ! # ? ยง ; * ~ / \ | ^ = [ ] { } ( ), line breaks or control characters. |
| lastname | string Last name of the user. Required where the workspace manages its people's profiles. Where people manage their own profile (one sign-in account for all their workspaces; is_profile_self_managed on their users) it must be omitted: the person enters it at first sign-in, and sending it is rejected with 422, problem type users/profile-self-managed. A blank value is rejected. Cannot contain < > & " $ % ! # ? ยง ; * ~ / \ | ^ = [ ] { } ( ), line breaks or control characters. |
| phone_number | string International phone number. An explicit '+' country code is required; common formatting is accepted and normalized to canonical E.164. National numbers are rejected. Omit the field to leave it unset; a blank value is rejected. Where people manage their own profile it must be omitted, like the names (422, problem type users/profile-self-managed). |
| role_ids required | Array of strings <uuid> non-empty unique [ items <uuid > ] Roles to assign to the user |
| skill_ids | Array of strings <uuid> unique [ items <uuid > ] Skills to assign to the user |
| tag_ids | Array of strings <uuid> unique [ items <uuid > ] Tags to assign to the user. When omitted, no tags are assigned. |
CreateAlpineTechnician
{- "email": "jonas.leitner@example.invalid",
- "firstname": "Jonas",
- "lastname": "Leitner",
- "phone_number": "+43 664 123 45 67",
- "role_ids": [
- "00000000-0000-4000-8000-000000001101"
], - "skill_ids": [
- "00000000-0000-4000-8000-000000006001"
], - "tag_ids": [
- "00000000-0000-4000-8000-000000005001"
]
}CreateUserResponse
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Unblocks a user who was blocked due to failed login attempts.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user to unblock |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Asks Keycloak to resend the set-password link to an invited user who has not signed in yet. Where people manage their own profile (is_profile_self_managed), it resends the invitation while profile_status is PENDING: the set-password link to a person new to Tourfold, an email that they were added to one who already has an account.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user to receive the set-password email |
| Origin | string |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Resends the invitation email for an invited user whose profile_status is PENDING (a set-password link for a person new to Tourfold, or an email that they were added to one who already has an account), or the set-password email where the workspace manages its people's profiles.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user to receive the invitation email |
| Origin | string |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Transfers the owner role to the target user. Only the current owner may call this endpoint. The current owner loses owner and keeps admin.
| user_id required | string <uuid> UUID of the user. |
TransferredOwner
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Deactivates the user, preventing them from accessing the system.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user to deactivate |
DeactivatedUser
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [ ],
- "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T10:00:00Z",
- "status": "INACTIVE",
- "lock_version": 1,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [ ]
}Activates the user, allowing them to access the system.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user to activate |
ActivatedUser
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Returns a single user by their unique identifier.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user to retrieve |
UserResponse
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Soft-deletes a user by marking the record as deleted (sets deleted_at timestamp). When anonymize=true, also anonymizes personal data (email, firstname, lastname, phone). The user will no longer appear in any API responses. Users cannot delete themselves. Users with the owner role cannot be deleted.
| user_id required | string <uuid> Example: 1ec2dffe-2a5b-4c59-9ea2-9f0c3c5ab5af UUID of the user to delete |
| anonymize | boolean Example: anonymize=true When true, anonymizes personal data (email, firstname, lastname, phone) in addition to soft-deleting |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON Merge Patch (RFC 7386) update of a user. Fields omitted remain unchanged, fields set to null are cleared. Email cannot be changed. When the user's is_profile_self_managed is true, only the user can change firstname, lastname and phone_number; sending their current values is accepted. A name or phone change is saved to the user's sign-in account first.
| user_id required | string <uuid> UUID of the user. |
| firstname | string First name of the user. Omitted leaves the value unchanged. Required: it cannot be cleared, and null or a blank value is rejected. Cannot contain < > & " $ % ! # ? ยง ; * ~ / \ | ^ = [ ] { } ( ), line breaks or control characters. |
| lastname | string Last name of the user. Omitted leaves the value unchanged. Required: it cannot be cleared, and null or a blank value is rejected. Cannot contain < > & " $ % ! # ? ยง ; * ~ / \ | ^ = [ ] { } ( ), line breaks or control characters. |
| phone_number | string or null International phone number. An explicit '+' country code is required; common formatting is accepted and normalized to canonical E.164. National numbers are rejected. Omitted leaves the value unchanged; explicit null clears it; a blank value is rejected. |
| role_ids | Array of strings <uuid> unique [ items <uuid > ] Roles to assign to the user. Omitted leaves the assignment unchanged; when provided it replaces the assigned roles and must contain at least one role. Explicit null and empty arrays are rejected (422). |
| lock_version | integer or null <int64> Optimistic locking version of the user aggregate; validated when provided (409 on mismatch), omitting it skips the concurrency check |
UpdateUserNull
{- "lock_version": 2,
- "firstname": "Mara",
- "phone_number": null
}UpdateUserResponse
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}CurrentUserResponse
{- "id": "00000000-0000-4000-8000-000000001002",
- "email": "jonas.leitner@example.invalid",
- "phone_number": "+436641234567",
- "roles": [
- "technician"
], - "skills": [
- {
- "id": "00000000-0000-4000-8000-000000006101",
- "name": "HVAC maintenance",
- "short_key": "hvac-maintenance"
}
], - "firstname": "Jonas",
- "lastname": "Leitner",
- "profile_status": "COMPLETE",
- "created_at": "2026-08-20T08:05:00Z",
- "updated_at": "2026-08-20T08:05:00Z",
- "status": "ACTIVE",
- "lock_version": 0,
- "can_resend_set_password_email": false,
- "is_profile_self_managed": true,
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Returns the workspace's human users with their display name and status, for choosing values of user fields on records. Any signed-in user may call it; the response never contains email addresses or other contact details. Deleted users and service accounts are never listed. Results are ordered by display name, then id.
| search | string Example: search=lei Matches first name, last name, full name or email address. |
| status | string Default: "ACTIVE" Enum: "ACTIVE" "ALL"
|
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
UserDirectory
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000001002",
- "display_name": "Jonas Leitner",
- "status": "ACTIVE"
}, - {
- "id": "00000000-0000-4000-8000-000000001007",
- "display_name": "Lea Leinweber",
- "status": "ACTIVE"
}
], - "page": {
- "size": 20,
- "total_elements": 2,
- "total_pages": 1,
- "number": 0
}
}Requires the 'tasks:read' grant.
| search | string Case-insensitive literal title substring or exact task number (123 or Task-123); blank is invalid |
| status | string Enum: "open" "done" Filter by completion state; omitted returns both states |
| assignee_user_id | string <uuid> Exact assignee; omitted includes every assignee and unassigned tasks |
| object_id | string <uuid> Object or concrete Vehicle definition UUID; requires record_id |
| record_id | string <uuid> Record UUID; requires object_id. Matches ad hoc links in any role or named custom relationships when the target is readable. Returns each Task once with the same matching for page totals |
| page | integer <int32> >= 0 Default: 0 Zero-based page number |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Maximum tasks per page |
| sort | string Default: "created_at:desc" Enum: "natural_id" "natural_id:asc" "natural_id:desc" "created_at" "created_at:asc" "created_at:desc" "updated_at" "updated_at:asc" "updated_at:desc" "title" "title:asc" "title:desc" "status" "status:asc" "status:desc" "id" "id:asc" "id:desc" One field[:direction] criterion. Fields: natural_id, created_at, updated_at, title, status, id. Directions: asc, desc; omitted direction means asc. Default: created_at:desc. Stable id tie-breaker. |
| ids | Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ] Only these Task UUIDs; repeat ids for each value. |
| has_visit | boolean True for visit tasks, false for other types |
| definition_id | string <uuid> Exact concrete Task definition |
| natural_id | integer <int64> >= 1 Exact human task number |
| type | string Concrete Task definition: built-in name, custom slug or UUID |
| execution_type | string Enum: "simple" "workflow_single_choice_question" "workflow_free_text_question" "visit" Execution behavior across definitions |
TaskBacklog
{- "items": [
- {
- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": "1",
- "definition_id": "46600000-0000-4000-8000-000000000001",
- "data": { },
- "type": "simple",
- "execution_type": "simple",
- "title": "Call customer to confirm delivery",
- "status": "open",
- "linked_records": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a simple or visit Task. Question Tasks are created only by workflow approval steps. Requires the 'tasks:write' grant.
| type required | string [ 1 .. 63 ] characters Definition selector: simple, visit, a custom Task definition slug, or a concrete Task definition UUID. Immutable after creation. |
| title required | string [ 1 .. 255 ] characters \S Nonblank Task title |
| assignee_user_id | string or null <uuid> User in this tenant; omitted or null leaves the Task unassigned |
Array of objects (TaskLinkedRecordInput) Complete record references; omission defaults to an empty array and null is rejected | |
object Custom values by attribute slug. Omitted fields receive defaults; null data is rejected. | |
TaskVisitInput (object) or null Required for a Visit definition; omitted or null for a Simple definition. The selected definition controls this requirement. |
SimpleTask
{- "type": "simple",
- "title": "Call customer to confirm delivery"
}OpenTask
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": "1",
- "definition_id": "46600000-0000-4000-8000-000000000001",
- "data": { },
- "type": "simple",
- "execution_type": "simple",
- "title": "Call customer to confirm delivery",
- "status": "open",
- "linked_records": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}Requires tasks:write and an active human user. Assignment organizes work and does not grant or restrict answering. Commits the accepted response, Task completion and durable owner continuation atomically. Identical retries by the same authorized human return the saved response even with the original lock_version. The workflow resumes asynchronously through the selected option path; rejection may continue. Expired/cancelled interactions cannot be answered.
| task_id required | string <uuid> Task UUID in this tenant |
| interaction_id required | string <uuid> |
| lock_version | integer or null <int64> >= 0 |
| type required | string |
| option_id required | string [ 1 .. 64 ] characters \S |
| comment | string [ 1 .. 2000 ] characters \S |
ChooseApproval
{- "type": "single_choice",
- "interaction_id": "6ba7b811-9dad-41d1-80b4-00c04fd430c8",
- "option_id": "approved",
- "lock_version": 0
}AcceptedChoice
{- "type": "workflow_single_choice_question",
- "execution_type": "workflow_single_choice_question",
- "id": "6ba7b810-9dad-41d1-80b4-00c04fd430c8",
- "natural_id": "1",
- "definition_id": "46600000-0000-4000-8000-000000000003",
- "title": "Approve assistance",
- "status": "done",
- "linked_records": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:01:00Z",
- "lock_version": 1,
- "interaction": {
- "id": "6ba7b811-9dad-41d1-80b4-00c04fd430c8",
- "type": "single_choice",
- "status": "answered",
- "prompt": "Approve assistance",
- "options": [
- {
- "id": "approved",
- "label": "Approve"
}, - {
- "id": "rejected",
- "label": "Reject"
}
], - "created_at": "2023-02-14T10:00:00Z",
- "expires_at": "2023-02-21T10:00:00Z",
- "closed_at": "2023-02-14T10:01:00Z",
- "response": {
- "option_id": "approved",
- "answered_at": "2023-02-14T10:01:00Z",
- "answered_by_user_id": "6ba7b812-9dad-41d1-80b4-00c04fd430c8"
}
}
}Requires the 'tasks:read' grant.
| task_id required | string <uuid> UUID of the task in the current tenant |
OpenTask
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": "1",
- "definition_id": "46600000-0000-4000-8000-000000000001",
- "data": { },
- "type": "simple",
- "execution_type": "simple",
- "title": "Call customer to confirm delivery",
- "status": "open",
- "linked_records": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}Only normal Tasks can be deleted. Question Tasks retain their decision history and return 409. Requires the 'tasks:write' grant.
| task_id required | string <uuid> UUID of the task in the current tenant |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Question Tasks permit reassignment but reject ordinary status changes and changes to their title or record context. Type is immutable. Requires the 'tasks:write' grant.
| task_id required | string <uuid> UUID of the task in the current tenant |
| title | string [ 1 .. 255 ] characters Nonblank title; null is rejected. |
| status | string Enum: "open" "done" Complete or reopen a normal Task; question Tasks reject this field with 409. Null is rejected. |
| assignee_user_id | string or null <uuid> User in the current tenant. Null clears the assignee. |
Array of objects (TaskLinkedRecordInput) Replaces the entire array, including roles. Empty array removes all links; null is rejected. Existing restricted links may be retained or removed. | |
| lock_version | integer or null <int64> >= 0 Version from the previous read. Stale versions return 409. Omitted or null skips the version precondition. |
object (UpdateTaskVisit) Replace the fixed visit destination. Only valid for visit tasks; null is rejected. | |
object Custom value patch: omitted fields stay unchanged, field null clears when allowed. Empty object preserves all values; null data is rejected. Not supported on workflow questions. |
CompleteAndUnassign
{- "status": "done",
- "assignee_user_id": null,
- "lock_version": 0
}CompletedTask
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": "1",
- "definition_id": "46600000-0000-4000-8000-000000000001",
- "data": { },
- "type": "simple",
- "execution_type": "simple",
- "title": "Call customer to confirm delivery",
- "status": "done",
- "linked_records": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:05:00Z",
- "lock_version": 1
}Returns canonical target records ordered by UUID. Requires tasks:read and the target collection read permission before records or totals are returned.
| task_id required | string <uuid> Task UUID |
| attribute_ref required | string Relationship attribute UUID or slug |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
EmptyPage
{- "items": [ ],
- "page": {
- "size": 20,
- "total_elements": 0,
- "total_pages": 0,
- "number": 0
}
}Query SMS message history for reporting and auditing. Returns all SMS sent through the system with status, timestamps, and gateway information.
Returns a paginated list of SMS messages for the current tenant, with optional filtering by date range and status.
**Date Range:**
- Defaults to last 28 days if not specified
- Filters on the `scheduled_at` timestamp using a half-open range
- Use RFC 3339 format (e.g., 2024-01-15T10:30:00Z)
**Status Values:**
- SCHEDULED: Waiting to be sent
- SENDING: Currently being sent
- SENT: Successfully accepted by gateway
- DELIVERED: Confirmed delivered to recipient (Twilio only, via webhook)
- READ: Confirmed read by recipient (Twilio only, via webhook)
- FAILED: Failed to send
**Sorting:**
- Default: `scheduled_at:desc` (newest first)
- Allowed fields: scheduled_at, sent_at, status, created_at, to_number, gateway_name
- Format: `field:asc` or `field:desc`
- Multiple sort criteria supported
| scheduled_from | string <date-time> Example: scheduled_from=2024-01-01T00:00:00Z Lower bound for |
| scheduled_to | string <date-time> Example: scheduled_to=2024-12-31T23:59:59Z Upper bound for |
| status | string Enum: "SCHEDULED" "SENDING" "SENT" "DELIVERED" "READ" "FAILED" Example: status=SENT Filter by SMS status |
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 1000 ] Default: 100 Example: size=100 Number of items per page (max 1000). The cap is deliberately higher than the platform default of 100 because this is a report/export-style endpoint. |
| sort | Array of strings Example: sort=scheduled_at:desc Repeated sorting criteria in |
SmsReportExample
{- "items": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174001",
- "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
- "to_number": "+12025551234",
- "from_number": "+12025559999",
- "message": "Your appointment is confirmed for tomorrow at 10 AM.",
- "gateway_name": "Primary Twilio",
- "scheduled_at": "2024-01-15T10:30:00Z",
- "sent_at": "2024-01-15T10:30:05Z",
- "status": "DELIVERED",
- "created_at": "2024-01-15T10:29:55Z"
}, - {
- "id": "123e4567-e89b-12d3-a456-426614174002",
- "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
- "to_number": "+12025555678",
- "from_number": "+12025559999",
- "message": "Test SMS from Tourfold.",
- "gateway_name": "Fallback Custom",
- "scheduled_at": "2024-01-15T09:15:00Z",
- "sent_at": "2024-01-15T09:15:02Z",
- "status": "SENT",
- "created_at": "2024-01-15T09:14:50Z"
}, - {
- "id": "123e4567-e89b-12d3-a456-426614174003",
- "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
- "to_number": "+12025559876",
- "message": "Reminder: Your case is scheduled for review.",
- "gateway_name": "Primary Twilio",
- "scheduled_at": "2024-01-15T08:00:00Z",
- "status": "FAILED",
- "failure_reason": "Authentication error: Invalid credentials",
- "created_at": "2024-01-15T07:59:55Z"
}
], - "page": {
- "number": 0,
- "size": 100,
- "total_elements": 3,
- "total_pages": 1
}
}Requires tours:read, or tours:read-own for memberships in published tours containing the current human user. Filters combine with AND; results sort by assignment id ascending.
| tour_id | string <uuid> Exact Tour UUID |
| task_ids | Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ] Filter by Task UUIDs; repeat task_ids for each value. |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Page size |
Success
{- "items": [
- {
- "id": "6b4528bd-8a92-497c-9aa9-6c049d99a5e2",
- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "tour_natural_id": 1,
- "position": 0,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Requires tasks:read and tours:update, or tours:execute-own for an own ad-hoc tour. Creates a visit stop atomically for a visit Task. Task content and version remain unchanged.
| task_id required | string <uuid> |
| tour_id required | string <uuid> |
Request
{- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522"
}Success
{- "id": "6b4528bd-8a92-497c-9aa9-6c049d99a5e2",
- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "tour_natural_id": 1,
- "position": 0,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}Requires tours:read or tours:read-own for a published tour containing the current human user.
| assignment_id required | string <uuid> Assignment UUID |
Success
{- "id": "6b4528bd-8a92-497c-9aa9-6c049d99a5e2",
- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "tour_natural_id": 1,
- "position": 0,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}Requires tours:update, or tours:execute-own for an own ad-hoc tour. Removes its visit stop atomically and preserves the Task.
| assignment_id required | string <uuid> Assignment UUID |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Requires tasks:read and planning access to both tours: tours:update, or tours:execute-own for an own ad-hoc tour. Preserves the assignment UUID. An exclusively task-backed stop moves with it; leaving a combined or dispatcher stop creates a new visit stop; neither changes Task content or version.
| assignment_id required | string <uuid> Assignment UUID |
| tour_id | string <uuid> |
| lock_version | integer or null <int64> >= 0 Assignment version. Omitted or null skips the precondition; stale versions return 409. |
Request
{- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "lock_version": 0
}Success
{- "id": "6b4528bd-8a92-497c-9aa9-6c049d99a5e2",
- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "tour_natural_id": 1,
- "position": 0,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}Get a vehicle definition.
| definition_ref required | string Vehicle definition UUID or slug |
| If-None-Match | string Optional ETag for conditional revalidation |
bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Atomically replace metadata and the complete authored attribute set. Omitted owned fields are removed; inherited/native/generated fields remain and must not be submitted. IDs preserve identity across renames; id-less existing slugs preserve identity. Validate the template against the final schema. Omitted icon, color and display_template are cleared. Plugin and system definitions are locked.
| definition_ref required | string Vehicle definition UUID or slug |
| natural_id_key | string or null^[A-Z][A-Z0-9]{0,15}$ Optional natural ID prefix, unique across definitions when set. Null means numeric-only string IDs. Omission preserves the prefix on PATCH and means no prefix on creation or replacement. Use 1โ16 uppercase letters or digits, starting with a letter. Changing it changes displayed IDs without changing record identity or counters. |
| slug required | string <= 63 characters ^[a-z][a-z0-9_]*$ Definition slug. |
required | object Complete localized names. |
required | Array of any (AttributeInput) <= 20 items Complete authored attribute set. Empty removes all owned fields, subject to data/dependency guards. |
| display_template | string [ 1 .. 2000 ] characters Template for the final schema. Omission or null restores the native label fallback; blank strings are rejected. |
| lock_version | integer <int64> >= 0 Optional version precondition; stale versions return 409. |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon key from the client icon catalog, for example |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Palette color of the definition icon. Omission or null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Attribute slugs shown, in order, under the record name and the clicked location in a map popup, for example |
replace
{- "slug": "bicycle",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "attributes": [
- {
- "slug": "serial_number",
- "type": "text",
- "name": {
- "en": "Serial number"
}
}
], - "lock_version": 0
}bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "33333333-9999-4444-8888-333333333333",
- "slug": "serial_number",
- "type": "text",
- "name": {
- "en": "Serial number"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Delete a tenant-owned definition only when it has no vehicles and no schema dependencies. Removes its attribute storage and outgoing relationships. Managed definitions cannot be deleted.
| definition_ref required | string Vehicle definition UUID or slug |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Partially update a Vehicle definition by UUID or slug. Omission preserves optional metadata; null clears icon, color, natural_id_key or display_template. Unset color is transparent. Plugin and system definitions allow icon, color and natural ID prefix changes only; their schema remains locked. Name translations and slug can also be changed. The UUID remains stable; the old slug stops resolving after rename. Attributes use their nested endpoints.
| definition_ref required | string Vehicle definition UUID or slug |
| natural_id_key | string or null^[A-Z][A-Z0-9]{0,15}$ Optional natural ID prefix, unique across definitions when set. Null means numeric-only string IDs. Omission preserves the prefix on PATCH and means no prefix on creation or replacement. Use 1โ16 uppercase letters or digits, starting with a letter. Changing it changes displayed IDs without changing record identity or counters. |
| slug | string <= 63 characters New definition slug; UUID and storage identity remain unchanged. Omitted preserves it; null is rejected. |
object Merge names by language and noun form. A null language removes its translation. Empty maps preserve current values. At least one localized name must remain; root null is rejected. | |
| display_template | string or null [ 1 .. 2000 ] characters Label template using {{slug}} native-field or column-backed attribute placeholders. Other attribute types are not supported in labels yet. Null restores the native fallback; blank strings are rejected. |
| lock_version | integer or null <int64> >= 0 Optional version precondition; stale versions return 409. |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon catalog key. Omission preserves it; null restores the default icon. |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Icon background palette color. Omission preserves it; null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Ordered popup field selection. Omission preserves it; null clears it to an empty list; an array replaces it. Lists and structured JSON fields are unsupported. |
label
{- "display_template": "Bike {{battery_wh}} Wh",
- "lock_version": 0
}bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}
], - "display_template": "Bike {{battery_wh}} Wh",
- "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Replaces the display order of all attributes atomically: the system attributes (id, created_at, updated_at, lock_version), the native definition_id and natural_id, inherited attributes such as location and managed reverse relationships, and the definition's own attributes. List every slug of the definition's attributes exactly once; the response returns attributes in this order, which also drives record forms and the default list columns. Only the order changes. Until an order is saved, id and the native fields come first and created_at, updated_at and lock_version come last. Later attribute additions are appended. Plugin and system definitions are locked.
| definition_ref required | string Vehicle definition UUID or slug |
| attribute_slugs required | Array of strings non-empty Slug of every attribute of the definition, each exactly once, in display order (first = topmost). This is the set of slugs in the definition's |
| lock_version | integer <int64> >= 0 Optimistic-locking version of the definition: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
batteryFirst
{- "attribute_slugs": [
- "battery_wh",
- "id",
- "definition_id",
- "natural_id",
- "location",
- "created_at",
- "updated_at",
- "lock_version"
], - "lock_version": 0
}bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "attributes": [
- {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}, - {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Vehicle definitions ordered by created_at ascending, then id ascending. Read with vehicles:read or schemas:write; authoring requires schemas:write.
| page | integer <int32> >= 0 Default: 0 Zero-based page number |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| If-None-Match | string Optional ETag for conditional revalidation |
bicycle
{- "items": [
- {
- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Create a tenant-owned Vehicle definition using the shared attribute types and optional display configuration; the native Vehicle base is implicit.
| natural_id_key | string or null^[A-Z][A-Z0-9]{0,15}$ Optional natural ID prefix, unique across definitions when set. Null means numeric-only string IDs. Omission preserves the prefix on PATCH and means no prefix on creation or replacement. Use 1โ16 uppercase letters or digits, starting with a letter. Changing it changes displayed IDs without changing record identity or counters. |
| slug required | string <= 63 characters ^[a-z][a-z0-9_]*$ Vehicle definition slug. The plugin_ prefix is reserved for plugin-managed definitions; all, self and this are reserved words. |
required | object Localized singular/plural names. |
Array of any (AttributeInput) <= 20 items Shared attribute definitions. All shared attribute types are supported, including relationships and ordinary location attributes; the intrinsic location is inherited and read-only. | |
| display_template | string [ 1 .. 2000 ] characters Optional record label template using {{slug}} placeholders for native fields or column-backed attributes. Relationship, location, tags and skills placeholders are not supported yet. Blank strings are rejected. |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon key from the client icon catalog, for example |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Palette color of the definition icon. Omission or null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Attribute slugs shown, in order, under the record name and the clicked location in a map popup, for example |
bicycle
{- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "attributes": [
- {
- "slug": "battery_wh",
- "type": "number",
- "config": {
- "minimum": 0,
- "default": 625
}
}
]
}bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Add one attribute to a tenant-owned Vehicle definition, using the same typed attribute payload as Objects. Returns the complete updated definition. Existing record values are preserved; defaults apply to future record creation, without backfilling existing records. The optional lock_version refers to the definition. Plugin and system definitions are locked.
| definition_ref required | string Vehicle definition UUID or slug |
| id | string <uuid> Existing attribute id (omit on create; send to update/rename) |
| slug required | string <= 200 characters ^[a-z][a-z0-9_]*$ Attribute slug; self, this and platform record fields are reserved. |
| type required | string Attribute type selecting this configuration. |
object Attribute label per language tag, e.g. {"en": "Purchase price"} | |
| description | string Optional attribute description |
object (TextAttributeConfigInput) Configuration for text attributes. | |
| lock_version | integer <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
range
{- "slug": "range_km",
- "type": "number",
- "name": {
- "en": "Range (km)"
}, - "config": {
- "is_integer": true,
- "minimum": 0
}, - "lock_version": 0
}bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}, - {
- "id": "55555555-9999-4444-8888-555555555555",
- "slug": "range_km",
- "type": "number",
- "name": {
- "en": "Range (km)"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": true,
- "minimum": 0
}
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Delete an owned attribute and its stored values/relationship edges. Generated reverse fields are removed together. Clear or update a display template referencing this attribute first. Native location and inherited/managed attributes cannot be deleted.
| definition_ref required | string Vehicle definition UUID or slug |
| attribute_ref required | string Owned attribute UUID or slug |
bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 3,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Merge an owned attribute by UUID or slug. Omitted fields are preserved; option/state arrays replace their set. Attribute and choice IDs preserve values through renames. Type, uniqueness, cardinality and relationship target are immutable. Managed and inherited attributes, including the native location, cannot be changed.
| definition_ref required | string Vehicle definition UUID or slug |
| attribute_ref required | string Owned attribute UUID or slug |
| id | string or null <uuid> Optional identity assertion; must match the routed attribute. |
| type | string or null Enum: "text" "license_plate" "vin" "number" "date" "date_time" "boolean" "select" "state" "capacity" "measure" "currency" "rating" "email" "phone" "tags" "required_skills" "provided_skills" "relationship" "location" "raw_json" "rich_text" "full_name" "links" null Optional type assertion; cannot change the stored type. |
| slug | string <= 200 characters ^[a-z][a-z0-9_]*$ New slug. Omission preserves it; null cannot clear it. |
object Merge localized labels. Null at a language key removes that translation. | |
| description | string or null Null clears the description; blank text is rejected. |
object or null Merge type-specific configuration keys with the stored configuration. Null clears an optional setting; null config resets optional configuration. Required settings, immutable uniqueness, unknown keys and keys belonging to another type are validated after merging. | |
Array of objects (SelectOptionInput) Select only: replaces choices; [] clears them. Existing choice IDs preserve stored values. | |
Array of objects (StateInput) State only: replaces states; [] clears them. Existing state IDs preserve stored values. | |
| lock_version | integer or null <int64> >= 0 Optional definition version precondition. |
rename
{- "slug": "estimated_range_km",
- "lock_version": 1
}bicycle
{- "id": "11111111-9999-4444-8888-111111111111",
- "slug": "bicycle",
- "natural_id_key": "BIKE",
- "name": {
- "en": {
- "singular": "Bicycle",
- "plural": "Bicycles"
}
}, - "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 2,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Natural ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "id": "44444444-9999-4444-8888-444444444444",
- "slug": "location",
- "type": "location",
- "name": {
- "en": "Location"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ],
- "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "id": "22222222-9999-4444-8888-222222222222",
- "slug": "battery_wh",
- "type": "number",
- "name": {
- "en": "battery_wh"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": false,
- "minimum": 0,
- "default": 625
}
}, - {
- "id": "55555555-9999-4444-8888-555555555555",
- "slug": "estimated_range_km",
- "type": "number",
- "name": {
- "en": "Range (km)"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false,
- "is_integer": true,
- "minimum": 0
}
}
], - "resource_type": "vehicle",
- "is_readonly": false,
- "is_relationship_target": true,
- "map_marker_fields": [ ]
}Tenant-wide workflow authoring and immutable publication. Requires workflows:manage; definitions and history may contain tenant-wide data.
Requires the 'workflows:manage' grant. Metadata only, without loading graphs. The trigger summary refers to the published version.
| search | string <= 255 characters Literal case-insensitive substring of name; blank is invalid |
| is_enabled | boolean Filter by enablement |
| is_published | boolean Filter by presence of a published version |
| trigger_object_id | string <uuid> Exact custom-object UUID selected by the published trigger |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| sort | string Default: "created_at:desc" Enum: "created_at" "created_at:asc" "created_at:desc" "updated_at" "updated_at:asc" "updated_at:desc" "name" "name:asc" "name:desc" "id" "id:asc" "id:desc" "run_count" "run_count:asc" "run_count:desc" "last_published_at" "last_published_at:asc" "last_published_at:desc" "last_failed_run_at" "last_failed_run_at:asc" "last_failed_run_at:desc" One field[:direction] criterion. Fields: created_at, updated_at, name, id, run_count, last_published_at, last_failed_run_at. asc/desc; omitted direction means asc. Default created_at:desc with stable id tie-breaker. Missing timestamps sort last in either direction. Run statistics use the local history projection. |
WorkflowPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000030",
- "name": "Follow up with new people",
- "description": "Creates a follow-up task for every new person.",
- "is_enabled": false,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "run_count": 0,
- "has_unpublished_changes": true
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Requires the 'workflows:manage' grant. Creates a disabled workflow parent without executable content. Create a nested working version to author its graph. Optional origin_tour_template_id records the saved template from which authoring began and additionally requires tour-templates:read; an unknown template returns 404.
| name required | string [ 1 .. 255 ] characters |
| description | string [ 1 .. 1000 ] characters Optional plain-text description, at most 1000 characters after trimming. Omit it when there is none; a blank value returns 422. |
| origin_tour_template_id | string <uuid> Optional creation origin. Requires tour-templates:read. Retained for the template's workflow panel even when actions change; origin alone never blocks template deletion. |
NamedWorkflow
{- "name": "Follow up with new people",
- "description": "Creates a follow-up task for every new person."
}WorkflowParent
{- "id": "00000000-0000-4000-8000-000000000030",
- "name": "Follow up with new people",
- "description": "Creates a follow-up task for every new person.",
- "is_enabled": false,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}Requires the 'workflows:manage' grant. Working and published version summaries with exactly one current publication, ordered by version_number descending with stable id tie-breaker.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
VersionPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000040",
- "workflow_id": "00000000-0000-4000-8000-000000000030",
- "version_number": 1,
- "name": "Follow up with new people",
- "published_at": "2023-02-14T10:00:00Z",
- "state": "published",
- "is_current": true,
- "lock_version": 2,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Requires workflows:manage. Creates the sole editable version, empty or copied from a version belonging to this workflow. An existing working version returns 409. Numbers are allocated at creation and never reused after deletion. Creating a version does not change the current publication or live state.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
| source_version_id | string <uuid> Version from this workflow to copy. The source stays unchanged. |
EmptyVersion
{ }WorkingVersion
{- "id": "00000000-0000-4000-8000-000000000040",
- "workflow_id": "00000000-0000-4000-8000-000000000030",
- "version_number": 1,
- "name": "Follow up with new people",
- "definition": {
- "format_version": 1,
- "triggers": [ ],
- "actions": [ ],
- "edges": [ ]
}, - "layout": {
- "nodes": [ ]
}, - "interpreter_version": 1,
- "action_version": 1,
- "state": "draft",
- "is_current": false,
- "lock_version": 0,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "validation_issues": [
- {
- "pointer": "#/definition/triggers",
- "message": "Exactly one trigger is required"
}, - {
- "pointer": "#/definition/actions",
- "message": "Add at least one action"
}
]
}Requires workflows:manage. Script and Agent graphs additionally require workflows:code:execute and every grant required by their selected tools. Validates the saved graph and freezes inline Script/Agent configuration and tool contracts atomically. Agents use bounded READ tools, aggregate budgets and shared AI metering. First publication enables the workflow atomically; later publications preserve its enabled or paused state. Existing runs retain their original graph and dependencies.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
| version_id required | string <uuid> Working version UUID belonging to this workflow |
| lock_version | integer <int64> >= 0 Stale values return 409; omitted or null skips the precondition. |
PublishSavedDraft
{- "lock_version": 1
}PublishedVersion
{- "id": "00000000-0000-4000-8000-000000000040",
- "workflow_id": "00000000-0000-4000-8000-000000000030",
- "version_number": 1,
- "name": "Follow up with new people",
- "published_at": "2023-02-14T10:00:00Z",
- "definition": {
- "format_version": 1,
- "triggers": [
- {
- "id": "00000000-0000-4000-8000-000000000001",
- "type": "record_created",
- "object_id": "00000000-0000-4000-8000-000000000020",
- "description": "Runs when a person is added."
}
], - "actions": [
- {
- "id": "00000000-0000-4000-8000-000000000002",
- "type": "create_task",
- "title": [
- {
- "type": "literal",
- "text": "Follow up with "
}, - {
- "type": "record_field",
- "source_node_id": "00000000-0000-4000-8000-000000000001",
- "field_path": "record.display_name",
- "expected_type": "text"
}
], - "link_trigger_record": true,
- "description": "Ask the owner to call within a day."
}
], - "edges": [
- {
- "source": "00000000-0000-4000-8000-000000000001",
- "target": "00000000-0000-4000-8000-000000000002"
}
]
}, - "layout": {
- "nodes": [ ]
}, - "interpreter_version": 1,
- "action_version": 1,
- "state": "published",
- "is_current": true,
- "lock_version": 2,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "validation_issues": [ ]
}Requires the 'workflows:manage' grant. Returns metadata, the working-version pointer and the sole current-publication pointer. Read nested versions for graph content and validation issues.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
WorkflowParent
{- "id": "00000000-0000-4000-8000-000000000030",
- "name": "Follow up with new people",
- "description": "Creates a follow-up task for every new person.",
- "is_enabled": false,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0
}Requires the 'workflows:manage' grant. Removes a workflow from management views while retaining published history. Rejects deletion while admitted runs lack a confirmed terminal outcome.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Requires the 'workflows:manage' grant. Merge metadata or enablement. Null clears description; changing it does not create a draft. Update executable content through the nested working version. Disabling stops future admissions; admitted runs continue. Null is rejected for required fields; arrays replace as a whole.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
| name | string [ 1 .. 255 ] characters |
| description | string or null [ 1 .. 1000 ] characters Plain-text description, at most 1000 characters after trimming. Null clears it and a blank value returns 422. Changing it does not create a draft or need publishing. |
| is_enabled | boolean |
| lock_version | integer or null <int64> >= 0 Stale values return 409; omitted or null skips the precondition. |
RenameWorkflow
{- "name": "Customer follow-up",
- "lock_version": 0
}WorkflowParent
{- "id": "00000000-0000-4000-8000-000000000030",
- "name": "Follow up with new people",
- "description": "Creates a follow-up task for every new person.",
- "is_enabled": false,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "draft_version_id": "00000000-0000-4000-8000-000000000040"
}Requires the 'workflows:manage' grant. Returns graph content, layout and validation for a working version, or the immutable snapshot for a published version. is_current identifies the sole current publication; earlier publications remain history.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
| version_id required | string <uuid> Version UUID belonging to this workflow |
PublishedVersion
{- "id": "00000000-0000-4000-8000-000000000040",
- "workflow_id": "00000000-0000-4000-8000-000000000030",
- "version_number": 1,
- "name": "Follow up with new people",
- "published_at": "2023-02-14T10:00:00Z",
- "definition": {
- "format_version": 1,
- "triggers": [
- {
- "id": "00000000-0000-4000-8000-000000000001",
- "type": "record_created",
- "object_id": "00000000-0000-4000-8000-000000000020",
- "description": "Runs when a person is added."
}
], - "actions": [
- {
- "id": "00000000-0000-4000-8000-000000000002",
- "type": "create_task",
- "title": [
- {
- "type": "literal",
- "text": "Follow up with "
}, - {
- "type": "record_field",
- "source_node_id": "00000000-0000-4000-8000-000000000001",
- "field_path": "record.display_name",
- "expected_type": "text"
}
], - "link_trigger_record": true,
- "description": "Ask the owner to call within a day."
}
], - "edges": [
- {
- "source": "00000000-0000-4000-8000-000000000001",
- "target": "00000000-0000-4000-8000-000000000002"
}
]
}, - "layout": {
- "nodes": [ ]
}, - "interpreter_version": 1,
- "action_version": 1,
- "state": "published",
- "is_current": true,
- "lock_version": 2,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "validation_issues": [ ]
}Requires workflows:manage. Deletes only an unpublished, unreferenced working version. Published versions remain immutable history. The allocated version number is never reused.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
| version_id required | string <uuid> Working version UUID belonging to this workflow |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Requires workflows:manage. Merge definition and layout; arrays replace whole sets and null cannot clear required structures. Published versions return 409. Incomplete valid graph shapes can be saved with validation_issues; publication requires all blockers to be resolved. The version lock is independent of the parent metadata lock.
| workflow_id required | string <uuid> Workflow UUID in this tenant |
| version_id required | string <uuid> Working version UUID belonging to this workflow |
object (WorkflowDefinitionUpdate) Merge fields into a working version definition. Arrays replace as a whole; null is rejected. Max 50 triggers, 20 actions, 100 edges, 32 tokens per action and 64 KiB serialized definition. | |
object (WorkflowLayoutPatch) Omitted positions remain unchanged. An empty nodes array clears positions. Null is rejected. Max 100 positions and 64 KiB serialized layout. | |
| lock_version | integer or null <int64> >= 0 Working version precondition, independent of the parent lock. Stale values return 409; omitted or null skips the check. |
SaveDefinition
{- "lock_version": 0,
- "definition": {
- "format_version": 1,
- "triggers": [
- {
- "id": "00000000-0000-4000-8000-000000000001",
- "type": "record_created",
- "object_id": "00000000-0000-4000-8000-000000000020",
- "description": "Runs when a person is added."
}
], - "actions": [
- {
- "id": "00000000-0000-4000-8000-000000000002",
- "type": "create_task",
- "title": [
- {
- "type": "literal",
- "text": "Follow up with "
}, - {
- "type": "record_field",
- "source_node_id": "00000000-0000-4000-8000-000000000001",
- "field_path": "record.display_name",
- "expected_type": "text"
}
], - "link_trigger_record": true,
- "description": "Ask the owner to call within a day."
}
], - "edges": [
- {
- "source": "00000000-0000-4000-8000-000000000001",
- "target": "00000000-0000-4000-8000-000000000002"
}
]
}
}SavedWorkingVersion
{- "id": "00000000-0000-4000-8000-000000000040",
- "workflow_id": "00000000-0000-4000-8000-000000000030",
- "version_number": 1,
- "name": "Follow up with new people",
- "definition": {
- "format_version": 1,
- "triggers": [
- {
- "id": "00000000-0000-4000-8000-000000000001",
- "type": "record_created",
- "object_id": "00000000-0000-4000-8000-000000000020",
- "description": "Runs when a person is added."
}
], - "actions": [
- {
- "id": "00000000-0000-4000-8000-000000000002",
- "type": "create_task",
- "title": [
- {
- "type": "literal",
- "text": "Follow up with "
}, - {
- "type": "record_field",
- "source_node_id": "00000000-0000-4000-8000-000000000001",
- "field_path": "record.display_name",
- "expected_type": "text"
}
], - "link_trigger_record": true,
- "description": "Ask the owner to call within a day."
}
], - "edges": [
- {
- "source": "00000000-0000-4000-8000-000000000001",
- "target": "00000000-0000-4000-8000-000000000002"
}
]
}, - "layout": {
- "nodes": [ ]
}, - "interpreter_version": 1,
- "action_version": 1,
- "state": "draft",
- "is_current": false,
- "lock_version": 1,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "validation_issues": [ ]
}Requires workflows:manage. Returns available exact contracts, filtered by current tool grants and sorted by name/version. Does not execute tools. supported_step_kinds identifies the supported consumers: Scripts support record and Tour SDK tools; Agents support READ tools plus native web.search@1 and web.fetch@1. Native web discovery requires workflows:code:execute. Scripts may explicitly select local writes. No pagination or cache.
NoPermittedTools
{- "items": [ ]
}Requires workflows:manage and tasks:read for Read, or tasks:write for Create/Update. Select definitions from Task definition discovery. Custom input names are stable attribute UUIDs; native inputs retain their names. Read outputs expose typed custom data by slug. No records are read and no cache is retained.
| definition_id required | string <uuid> Concrete Simple or Visit Task definition UUID |
| action required | string Enum: "create_task" "read_task" "update_task" Task action whose authoring contract to describe |
simpleTask
{- "type": "create_task",
- "input_schema": {
- "type": "object",
- "additionalProperties": false,
- "properties": { },
- "required": [ ]
}, - "output_schema": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "definitionId": {
- "type": "string",
- "format": "uuid"
}, - "data": {
- "type": "object",
- "additionalProperties": false,
- "properties": { },
- "required": [ ]
}, - "relationshipPageInfo": {
- "type": "object",
- "additionalProperties": true
}, - "id": {
- "type": "string",
- "format": "uuid"
}, - "naturalId": {
- "type": "integer",
- "minimum": 1
}, - "type": {
- "type": "string",
- "enum": [
- "simple",
- "visit",
- "workflow_single_choice_question",
- "workflow_free_text_question"
]
}, - "title": {
- "type": "string",
- "minLength": 1,
- "maxLength": 255,
- "pattern": "\\S"
}, - "status": {
- "type": "string",
- "enum": [
- "open",
- "done"
]
}, - "assigneeUserId": {
- "type": [
- "string",
- "null"
], - "format": "uuid"
}, - "lockVersion": {
- "type": "integer",
- "minimum": 0
}, - "location": {
- "anyOf": [
- {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "address_label": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "street": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "street_additional": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "city": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "region": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "postal_code": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "country_code": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "located_at": {
- "type": "string",
- "format": "date-time"
}, - "lat": {
- "type": "number",
- "minimum": -90,
- "maximum": 90
}, - "lon": {
- "type": "number",
- "minimum": -180,
- "maximum": 180
}
}, - "required": [
- "lat",
- "lon"
]
}, - {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "address_label": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "street": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "street_additional": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "city": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "region": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "postal_code": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "country_code": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1000,
- "pattern": "\\S"
}, - "located_at": {
- "type": "string",
- "format": "date-time"
}
}, - "required": [
- "street",
- "country_code"
]
}, - {
- "type": "null"
}
]
}
}, - "required": [
- "id",
- "naturalId",
- "type",
- "title",
- "status",
- "lockVersion",
- "location",
- "definitionId",
- "data",
- "relationshipPageInfo"
]
}
}Requires workflows:manage and tour-templates:read for template targets, tasks:read for Task targets, or objects:configuration:read for Object schema targets. Current includes active drafts, publications (also paused workflows), and origins of non-deleted workflows. All includes retained versions and deleted workflows. Origins do not block deletion. Task schema and required fixed relationship dependencies remain blocking in retained history; other historical references do not. Results are ordered by workflow name/ID, version descending, source ID and reference ID. Deleted targets may retain reference history.
| target_type required | string Enum: "tour_template" "object_definition" "object_attribute" "task_definition" "task_relationship_record" Resource type |
| target_id required | string <uuid> Resource UUID |
| object_id | string <uuid> Required for object_attribute (owning definition), or task_relationship_record (target definition) |
| scope | string Default: "current" Enum: "current" "all" Current authoring references or all retained history |
| blocks_deletion | boolean Filter by the current deletion-blocking policy |
| page | integer <int32> >= 0 Default: 0 Page number, starting at 0. Defaults to 0; must be nonnegative. |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Number of references per page, from 1 to 100. Defaults to 20. |
EmptyReferences
{- "items": [ ],
- "page": {
- "size": 20,
- "number": 0,
- "total_elements": 0,
- "total_pages": 0
}
}Requires workflows:manage. Tenant-wide object metadata, sorted by English name or slug with UUID tie-breaker. purpose=trigger excludes built-in objects. purpose=record includes structurally supported record-operation targets, including eligible built-ins. Does not read records or grant record access. No cache.
| search | string <= 255 characters Literal search across slug and translated names; blank is invalid |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| purpose | string Default: "trigger" Enum: "trigger" "record" Object eligibility for a trigger or record operation |
AvailableObjects
{- "items": [
- {
- "id": "d1e94620-8a95-4b25-a9b2-ea886e93b971",
- "slug": "machine",
- "names": {
- "en": "Machine"
}, - "icon": "wrench",
- "color": "blue"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Requires workflows:manage and objects:records:read plus ordinary object READ ACL. Selecting writable fields also requires objects:records:update and object WRITE ACL. Returns object/field choices, exact projected output schema and canonical input schemas without reading records. At most 512 distinct IDs per selection; omit empty selections. Incomplete related scopes are allowed here; publication separately validates the full explicit closure. No cache.
| object_id required | string <uuid> UUID of the custom object whose field contracts are being described |
| readable_attribute_ids | Array of strings <uuid> [ 1 .. 512 ] items [ items <uuid > ] Selected readable attribute UUIDs. Repeat this plural query key once per value; CSV is rejected. At most 512 distinct values; omit for none. |
| writable_attribute_ids | Array of strings <uuid> [ 1 .. 512 ] items [ items <uuid > ] Selected writable attribute UUIDs. Repeat this plural query key once per value; CSV is rejected. At most 512 distinct values; omit for none. |
UnselectedFields
{- "object": {
- "id": "d1e94620-8a95-4b25-a9b2-ea886e93b971",
- "slug": "machine",
- "names": {
- "en": "Machine"
}
}, - "fields": [ ],
- "output_schema": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid"
}, - "objectId": {
- "type": "string",
- "format": "uuid"
}, - "displayName": {
- "type": "string"
}, - "createdAt": {
- "type": "string",
- "format": "date-time"
}, - "updatedAt": {
- "type": "string",
- "format": "date-time"
}, - "lockVersion": {
- "type": "integer",
- "minimum": 0
}, - "data": {
- "type": "object",
- "additionalProperties": false,
- "properties": { },
- "required": [ ]
}, - "relationshipPageInfo": {
- "type": "object",
- "additionalProperties": false,
- "properties": { },
- "required": [ ]
}
}, - "required": [
- "id",
- "objectId",
- "displayName",
- "createdAt",
- "updatedAt",
- "lockVersion",
- "data",
- "relationshipPageInfo"
]
}, - "writable_fields": [ ]
}Requires workflows:manage. Scalar trigger values for mappings, conditions and changed-field filters: text, number, boolean and date_time. Title tokens require text fields. display_name comes first, then attributes by slug. Does not read records. No cache.
| object_id required | string <uuid> Custom-object UUID in this tenant |
AvailableFields
{- "items": [
- {
- "path": "record.display_name",
- "expected_type": "text",
- "names": { }
}
]
}Requires workflows:manage. Returns implemented trigger/action types, publication limits, Script runtime limits and Agent output modes, budget ceilings and exact model configurations. Does not read records, contact providers, check worker health or grant execution permission. Tool selection remains separately grant-filtered at /workflows/tools; publication and execution validate current authority. Existing versions retain their frozen settings; provider rate estimates are captured per dispatch. No cache.
SupportedCapabilities
{- "format_version": 1,
- "trigger_types": [
- "record_created",
- "record_updated",
- "manual_record",
- "recurring"
], - "action_types": [
- "read_task",
- "create_task",
- "update_task",
- "ask_question",
- "if_else",
- "join",
- "wait",
- "end",
- "script",
- "agent",
- "read_record",
- "update_record",
- "upsert_record",
- "list_tour_templates",
- "read_tour_template",
- "read_tour",
- "create_tour",
- "update_tour",
- "set_tour_participants",
- "publish_tour"
], - "task_actions": [ ],
- "tour_actions": [ ],
- "limits": {
- "published_trigger_count": 1,
- "min_action_count": 1,
- "max_action_count": 20,
- "max_edges": 100,
- "max_input_bindings": 32,
- "max_conditions": 10,
- "max_wait_seconds": 2592000,
- "max_question_timeout_seconds": 2592000,
- "default_question_timeout_seconds": 604800
}, - "scripts": {
- "runtime": "javascript",
- "entrypoint": "main",
- "max_cpu_millis": 1000,
- "max_duration_millis": 25000,
- "max_input_bytes": 65536,
- "max_output_bytes": 65536,
- "max_log_bytes": 8192,
- "max_tool_calls": 16
}, - "agents": {
- "output_modes": [
- "text",
- "classification",
- "structured"
], - "models": [
- {
- "id": "claude-haiku-4-5-20251001",
- "name": "Claude Haiku 4.5",
- "inference": {
- "thinking": "disabled"
}, - "pricing": {
- "currency": "USD",
- "input_microusd_per_million": 1000000,
- "output_microusd_per_million": 5000000,
- "cache_read_microusd_per_million": 100000,
- "cache_write_5m_microusd_per_million": 1250000,
- "cache_write_1h_microusd_per_million": 2000000
}, - "max_output_tokens": 8192,
- "is_default": false
}, - {
- "id": "claude-sonnet-5",
- "name": "Claude Sonnet 5",
- "inference": {
- "thinking": "adaptive",
- "effort": "high",
- "inference_geo": "global"
}, - "pricing": {
- "currency": "USD",
- "input_microusd_per_million": 2000000,
- "output_microusd_per_million": 10000000,
- "cache_read_microusd_per_million": 200000,
- "cache_write_5m_microusd_per_million": 2500000,
- "cache_write_1h_microusd_per_million": 4000000
}, - "max_output_tokens": 8192,
- "is_default": false
}
], - "max_output_tokens": 8192,
- "max_total_tokens": 1000000,
- "max_model_calls": 100,
- "max_tool_calls": 100,
- "max_duration_seconds": 3600,
- "max_cost_microusd": 100000000
}
}Requires workflows:manage. Resolve one exact custom-object UUID or slug and its scalar trigger fields in one read. An optional assignee search returns the first five candidates with pagination metadata. Include capabilities for Script/Agent limits and models; tools for at most seven grant-filtered SDK/native contracts; record_schema for exact field/choice/read/write contracts. record_schema also requires objects:records:read plus object READ ACL; writable selections require objects:records:update plus object WRITE ACL. Does not read records, execute steps or change configuration. Existing step-version contracts remain available from the version read endpoints. No cache.
| object_ref required | string [ 1 .. 255 ] characters Exact custom-object slug or UUID |
| assignee_search | string [ 1 .. 255 ] characters Optional literal assignee name/email search, returning the first five matches |
| include | Array of strings [ 1 .. 3 ] items Items Enum: "capabilities" "record_schema" "tools" Optional metadata parts; repeat once per distinct value |
| readable_attribute_ids | Array of strings <uuid> [ 1 .. 512 ] items [ items <uuid > ] Readable attribute UUIDs for included record_schema; at most 512 distinct values |
| writable_attribute_ids | Array of strings <uuid> [ 1 .. 512 ] items [ items <uuid > ] Writable attribute UUIDs for included record_schema; at most 512 distinct values |
BasicContext
{- "object": {
- "id": "d1e94620-8a95-4b25-a9b2-ea886e93b971",
- "slug": "machine",
- "names": {
- "en": "Machine"
}, - "icon": "wrench",
- "color": "blue"
}, - "trigger_fields": [
- {
- "path": "record.display_name",
- "expected_type": "text",
- "names": { }
}
]
}Requires workflows:manage. All non-deleted tenant users accepted by Task assignment, including inactive, API-only and service-account users. Independent of users:read. Fixed case-insensitive display-name order (trimmed first and last names, email fallback), then UUID. Answering a human question has separate active-human restrictions. No cache.
| search | string <= 255 characters Literal case-insensitive first-name, last-name, full-name or email search; omitted lists all eligible users, blank is invalid |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
AvailableAssignees
{- "items": [ ],
- "page": {
- "size": 20,
- "total_elements": 0,
- "total_pages": 0,
- "number": 0
}
}List vehicles in a definition. Repeat include to expand named relationship pointers by one level under record. A 10-second execution deadline also covers canonical display-name search.
| definition_ref required | string Vehicle definition UUID or slug |
| page | integer <int32> >= 0 Default: 0 Zero-based page number |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| sort | Array of strings Common fields and sortable definition attributes (is_sortable); one to-one relationship.field hop. Repeat field:direction criteria; default created_at:desc with an id tie-breaker. |
| search | string Literal case-insensitive substring of canonical display_name (maximum 256 characters). Applied before count and pagination. |
| include | Array of strings Relationship attributes to expand one level. Repeat |
bicycle
{- "items": [
- {
- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Create a vehicle in a definition.
| definition_ref required | string Vehicle definition UUID or slug |
object Definition-owned attribute values, including relationships and inline references. Omitted attributes receive their configured defaults. | |||
| |||
bicycle
{- "data": {
- "battery_wh": 750
}
}bicycle
{- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}Queries the full linked set and returns canonical target records in kind-discriminated wrappers. Uses the target collection grammar: flat attributes for a concrete definition, common fields for the Vehicle family. Target read access is checked before any result or count. Read-only, with a 10-second wall-clock deadline (503 records/query-timeout).
| definition_ref required | string Vehicle definition UUID or slug |
| vehicle_id required | string <uuid> Vehicle UUID |
| attribute_ref required | string Relationship attribute UUID or slug |
object Filter tree evaluated against the target collection's attributes (Vehicle families accept common fields only). Relationship filters may nest up to four levels. | |
| sort | Array of strings Sort clauses |
| page | integer <int32> [ 0 .. 21474836 ] Default: 0 Page number (0-based, max 21474836). |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Number of items per page (max 100). |
query
{- "sort": [
- "created_at:desc"
], - "page": 0,
- "size": 20
}records
{- "items": [
- {
- "kind": "vehicle",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "record": {
- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Uses the same flat attribute filter and sort grammar as Objects. Filters and sorting precede count and pagination. Relationship targets require read access, including empty collections. Read-only, with a 10-second wall-clock deadline (503 records/query-timeout).
| definition_ref required | string Vehicle definition UUID or slug |
object Filter tree with and/or arrays, not, and field operator objects. Operators are eq/ne/in/gt/gte/lt/lte/contains/starts_with/ends_with/is_null where applicable. Maximum four filter levels. Scoped queries also accept relationship sub-filters. Aggregate fields: id, definition_id, natural_id, created_at, updated_at. | |
| sort | Array of strings field:asc|desc clauses (bare field means asc). Scoped queries allow sortable attribute slugs and one to-one relationship.field hop. Aggregate queries allow only common fields. Default created_at:desc, with stable id tiebreaker. |
| search | string <= 256 characters Literal case-insensitive substring of canonical display_name, applied before count and pagination. Trimmed; blank returns 422. |
| include | Array of strings Relationship attributes to expand one level. Expansion adds the canonical target record under record; relationships inside it remain compact. |
| page | integer <int32> [ 0 .. 21474836 ] Default: 0 Zero-based page number. |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page. |
query
{- "filter": {
- "battery_wh": {
- "gte": 500
}
}, - "sort": [
- "battery_wh:desc"
], - "page": 0,
- "size": 20
}records
{- "items": [
- {
- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Only id, definition_id, natural_id, created_at and updated_at are queryable. Filtering definition_id never enables definition-specific filters or sorts. Search matches canonical display names across definitions. Read-only, with a 10-second wall-clock deadline (503 records/query-timeout).
object Filter tree with and/or arrays, not, and field operator objects. Operators are eq/ne/in/gt/gte/lt/lte/contains/starts_with/ends_with/is_null where applicable. Maximum four filter levels. Scoped queries also accept relationship sub-filters. Aggregate fields: id, definition_id, natural_id, created_at, updated_at. | |
| sort | Array of strings field:asc|desc clauses (bare field means asc). Scoped queries allow sortable attribute slugs and one to-one relationship.field hop. Aggregate queries allow only common fields. Default created_at:desc, with stable id tiebreaker. |
| search | string <= 256 characters Literal case-insensitive substring of canonical display_name, applied before count and pagination. Trimmed; blank returns 422. |
| include | Array of strings Relationship attributes to expand one level. Expansion adds the canonical target record under record; relationships inside it remain compact. |
| page | integer <int32> [ 0 .. 21474836 ] Default: 0 Zero-based page number. |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page. |
query
{- "filter": {
- "natural_id": {
- "eq": "BIK-1"
}
}, - "page": 0,
- "size": 20
}records
{- "items": [
- {
- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Get a vehicle in a definition. Repeat include to expand named relationship pointers by one level under record.
| definition_ref required | string Vehicle definition UUID or slug |
| vehicle_id required | string <uuid> Native vehicle UUID |
| include | Array of strings Relationship attributes to expand one level. Repeat |
bicycle
{- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}Permanently delete a Vehicle in its concrete definition. Requires vehicles:delete. Active or ended device connection history, BW/รAMTC tour history and remaining รAMTC branch assignments return 409. Successful deletion removes attribute values, tags, skills, locations and relationship edges atomically and emits vehicle.deleted. No body or version is accepted.
| definition_ref required | string Vehicle definition UUID or slug |
| vehicle_id required | string <uuid> Native vehicle UUID |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Omitted fields stay unchanged. Null clears an optional attribute within data. data cannot be null. Attribute changes advance one shared lock_version; a semantic no-op leaves it unchanged. BW active-tour restrictions apply.
| definition_ref required | string Vehicle definition UUID or slug |
| vehicle_id required | string <uuid> Native vehicle UUID |
object Supplied attributes replace their values; null clears a clearable attribute. Empty object changes nothing. | |
| lock_version | integer or null <int64> >= 0 Optional version precondition; stale versions return 409. |
bicycle
{- "lock_version": 0,
- "data": {
- "battery_wh": 800
}
}bicycle
{- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "data": {
- "battery_wh": 800
}
}Returns canonical target records in kind-discriminated wrappers, ordered by UUID. Target read permission is required before records or counts are returned. Accepts a forward or generated reverse relationship attribute.
| definition_ref required | string Vehicle definition UUID or slug |
| vehicle_id required | string <uuid> Native vehicle UUID |
| attribute_ref required | string Relationship attribute UUID or slug |
| page | integer <int32> >= 0 Default: 0 Zero-based page number |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
relatedVehicles
{- "items": [
- {
- "kind": "vehicle",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "record": {
- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Lookup inside one definition using a declared unique scalar attribute (config.is_unique). Attribute UUIDs and slugs are accepted. Text matches the stored key exactly; numeric values parse as decimals and choices accept their value or UUID. Plate and VIN are not normalized or implicitly unique. Returns the canonical Vehicle record.
| definition_ref required | string Vehicle definition UUID or slug |
| attribute_ref required | string Unique attribute UUID or slug |
| attribute_value required | string Required non-blank key. Query encoding preserves URL path delimiters. |
bicycle
{- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}List vehicles across definitions using common fields only. A 10-second execution deadline also covers canonical display-name search.
| page | integer <int32> >= 0 Default: 0 Zero-based page number |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| sort | Array of strings Native fields only: id, natural_id, definition_id, created_at, updated_at. Repeat field:direction criteria; default created_at:desc with an id tie-breaker. |
| search | string Literal case-insensitive substring of canonical display_name (maximum 256 characters). Applied before count and pagination. |
bicycle
{- "items": [
- {
- "id": "aaaaaaaa-cccc-4ccc-8ccc-dddddddddddd",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "natural_id": "BIKE-7",
- "display_name": "BIKE-7",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "data": {
- "battery_wh": 750
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Returns workspace enrollment settings and the default Tourfold app location policy. Device overrides take precedence. Use lock_version when updating to detect concurrent edits.
WorkspaceDeviceSettings
{- "admin_managed_devices": false,
- "app_location_tracking_policy": "continuous",
- "lock_version": 0
}Merge patch: omission preserves a setting; null is rejected for required settings. Device overrides take precedence over the workspace location policy.
| admin_managed_devices | boolean Require administrator provisioning for Device enrollment. Cannot be null. |
| app_location_tracking_policy | string Enum: "disabled" "during_work" "continuous" Default Tourfold app GPS collection policy. Cannot be null. |
| lock_version | integer or null <int64> Optional version; stale values return 409. Omission or null skips the check. |
UpdateAppLocationPolicy
{- "app_location_tracking_policy": "during_work",
- "lock_version": 0
}UpdatedWorkspaceDeviceSettings
{- "admin_managed_devices": false,
- "app_location_tracking_policy": "during_work",
- "lock_version": 1
}Returns 200 with no location when unknown. Stale positions from the selected association are retained. Deselecting a source retains its last-known fix but prevents it from supplying new observations. Observation age can be derived from location.located_at when present. The selected association and position provenance are separate.
| definition_ref required | string Vehicle definition UUID or slug |
| vehicle_id required | string <uuid> Native vehicle UUID |
example
{- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "source_status": "selected",
- "source": {
- "kind": "fixed_device",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "device_display_name": "Van tablet",
- "details_restricted": false
}, - "location": {
- "lat": 48.2,
- "lon": 16.3,
- "located_at": "2023-02-14T10:00:00Z"
}, - "vehicle_association_id": "00000000-0000-4000-8000-000000000011"
}Returns measure units ordered by name, paginated.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
CapacityUnitsPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000006501",
- "name": "Kilograms",
- "symbol": "kg",
- "created_at": "2026-08-20T08:20:00Z",
- "updated_at": "2026-08-20T08:20:00Z",
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a tenant measure unit with a unique name and symbol.
| name required | string [ 1 .. 255 ] characters Human-readable name, e.g. "Kilogram" |
| symbol required | string [ 1 .. 64 ] characters Symbol, e.g. "kg" |
CreateKilogramsUnit
{- "name": "Kilograms",
- "symbol": "kg"
}CreatedKilogramsUnit
{- "id": "00000000-0000-4000-8000-000000006501",
- "name": "Kilograms",
- "symbol": "kg",
- "created_at": "2026-08-20T08:20:00Z",
- "updated_at": "2026-08-20T08:20:00Z",
- "lock_version": 0
}Returns one tenant measure unit by its UUID.
| measure_unit_id required | string <uuid> UUID of the measure unit. |
KilogramsUnit
{- "id": "00000000-0000-4000-8000-000000006501",
- "name": "Kilograms",
- "symbol": "kg",
- "created_at": "2026-08-20T08:20:00Z",
- "updated_at": "2026-08-20T08:20:00Z",
- "lock_version": 0
}Permanently removes a tenant measure unit. Refused with 409 while any object, task or vehicle definition attribute (capacity with unit_kind: measure, or measure) still references it.
| measure_unit_id required | string <uuid> UUID of the measure unit. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Partial update: omitted fields remain unchanged.
| measure_unit_id required | string <uuid> UUID of the measure unit. |
| name | string [ 1 .. 255 ] characters Human-readable name, e.g. "Kilogram". Omitted leaves the value unchanged. Explicit null is rejected (422) โ name is required and cannot be cleared. |
| symbol | string [ 1 .. 64 ] characters Symbol, e.g. "kg". Omitted leaves the value unchanged. Explicit null is rejected (422) โ symbol is required and cannot be cleared. |
| lock_version | integer or null <int64> Lock version for optimistic locking |
UpdateKilogramsName
{- "name": "Kilograms (kg)",
- "lock_version": 0
}UpdatedKilogramsUnit
{- "id": "00000000-0000-4000-8000-000000006501",
- "name": "Kilograms (kg)",
- "symbol": "kg",
- "created_at": "2026-08-20T08:20:00Z",
- "updated_at": "2026-08-20T09:20:00Z",
- "lock_version": 1
}Requires tours:read, or tours:read-own for a published Tour containing the current user (checked first; concealed or unknown Tours return 404). Returns every stop in position order; maximum 500. When any stop is task_visit or has non-empty task_ids, also requires tasks:read (failing with 403 access-denied, reason missing_grant and required_grants [tasks:read]).
| tour_id required | string <uuid> Parent tour UUID |
Success
{- "items": [
- {
- "id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "type": "standalone",
- "position": 0,
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "address_label": "Vienna depot"
}, - "status": "open",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "task_ids": [ ]
}
]
}Requires tours:update, or tours:execute-own for an own ad-hoc tour. Task stops are created by assigning visit tasks.
| tour_id required | string <uuid> Parent tour UUID |
required | FixedLocationInput (object) or FixedLocationInput (object) (FixedLocationInput) Fixed location: both coordinates or an address with street and country_code. Tracking must be resolved and removed before copying. | ||||||||||||||||||||
Any of
| |||||||||||||||||||||
Request
{- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "address_label": "Vienna depot"
}
}Success
{- "id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "type": "standalone",
- "position": 0,
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "address_label": "Vienna depot"
}, - "status": "open",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "task_ids": [ ]
}Requires tours:update or own ad-hoc planning access. Moves every Task assignment from the source stop to the destination, removes the source, and compacts the order atomically. The destination keeps its location and lifetime. No Task is changed. Combining explicitly removes the source, including a dispatcher-created source; the destination keeps its existing completion state.
| tour_id required | string <uuid> Parent Tour UUID |
| stop_id required | string <uuid> Destination stop UUID to keep |
| source_stop_id required | string <uuid> A different stop in the same tour |
| lock_version | integer or null <int64> >= 0 Parent Tour version. Omitted or null skips the precondition; stale versions return 409. |
Request
{- "source_stop_id": "686e3665-4c5a-42aa-9f6c-8bc606f66c1a",
- "lock_version": 2
}Combined
{- "id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "type": "task_visit",
- "position": 0,
- "task_ids": [
- "07b8775e-49d7-4980-adfe-1423a87765ab",
- "9bd78c05-ad21-4da2-8f7a-a15ab5c25dd5"
], - "location": {
- "lat": 48.2,
- "lon": 16.3
}, - "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1
}Requires tours:read, or tours:read-own for a published Tour containing the current user (checked first; concealed or unknown Tours and stops return 404). The planned location belongs to the stop; task_ids identifies all grouped Tasks. When the stop is task_visit or has non-empty task_ids, also requires tasks:read (failing with 403 access-denied, reason missing_grant and required_grants [tasks:read]).
| tour_id required | string <uuid> Parent tour UUID |
| stop_id required | string <uuid> Stop UUID belonging to this tour |
Success
{- "id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "type": "standalone",
- "position": 0,
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "address_label": "Vienna depot"
}, - "status": "open",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "task_ids": [ ]
}Requires tours:update or own ad-hoc planning access. Task-backed stops are removed through task assignment. Dispatcher-created stops with assignments return 409 until unassigned.
| tour_id required | string <uuid> Parent tour UUID |
| stop_id required | string <uuid> Stop UUID belonging to this tour |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Requires tours:update or own ad-hoc planning access for location edits. Status-only edits also allow tours:execute-own for participants. The planned location of task-backed stops is editable, but their completion is controlled by the assigned Tasks.
| tour_id required | string <uuid> Parent tour UUID |
| stop_id required | string <uuid> Stop UUID belonging to this tour |
object (UpdateFixedLocation) Merge fields into the current location. Omit to preserve; null clears a field. The merged location must remain complete. | |
| status | string Enum: "open" "done" |
| lock_version | integer or null <int64> >= 0 Stop version, not parent tour version. Omitted or null skips the precondition. |
Request
{- "status": "done",
- "lock_version": 0
}Success
{- "id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "tour_id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "type": "standalone",
- "position": 0,
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "address_label": "Vienna depot"
}, - "status": "done",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "task_ids": [ ]
}Fixed ordering: started_at descending, then id ascending. By default only active episodes are returned. Optional vehicle_id, device_id, and operational filters combine with AND.
| vehicle_id | string <uuid> |
| device_id | string <uuid> |
| operational | boolean |
| lifecycle | string Default: "current" Enum: "current" "all" |
| page | integer <int32> >= 0 Default: 0 |
| size | integer <int32> [ 1 .. 100 ] Default: 20 |
example
{- "items": [ ],
- "page": {
- "size": 20,
- "total_elements": 0,
- "total_pages": 0,
- "number": 0
}
}Creates a fixed or portable association, or selects an operational work Device. The first configured tracker or fixed tablet is selected automatically; portable Devices require explicit source selection. Existing plugin work-Device rules take precedence. A matching active pair and configuration returns 200; contradictory create intent conflicts.
| vehicle_id required | string <uuid> |
| device_id required | string <uuid> |
| association_mode | string Enum: "fixed" "portable" Required unless operational is true, in which case the plugin's operational mode applies by default. |
| operational | boolean Select this Device as the Vehicle's operational work Device (available when an enabled plugin uses operational work Devices). |
| is_location_source | boolean Omitted applies source defaults. Explicit selection must respect tracker/fixed priority. |
| is_preferred_fixed_source | boolean Choose this fixed app Device for GPS when no tracker has priority. |
device
{- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "association_mode": "portable",
- "is_location_source": true
}example
{- "id": "00000000-0000-4000-8000-000000000011",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "association_mode": "portable",
- "started_at": "2023-02-14T10:00:00Z",
- "operational": false,
- "is_location_source": true,
- "is_preferred_fixed_source": false,
- "lock_version": 0,
- "device_details_restricted": false
}Optionally checks lock_version against the active episode. An ended episode always conflicts. Closes it and creates a new episode atomically. A target equal to the current Vehicle returns 200 without creating history. The required association_mode configures the new Vehicle pair; source defaults are validated at the destination. A same-Vehicle request must match the existing mode; use PATCH to change or confirm it. Plugin rules remain enforced.
| association_id required | string <uuid> UUID of the device assignment episode, including ended episodes |
| vehicle_id required | string <uuid> |
| association_mode required | string Enum: "fixed" "portable" |
| lock_version | integer <int64> >= 0 |
handover
{- "vehicle_id": "00000000-0000-4000-8000-000000000003",
- "association_mode": "portable",
- "lock_version": 0
}example
{- "id": "00000000-0000-4000-8000-000000000011",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "association_mode": "portable",
- "started_at": "2023-02-14T10:00:00Z",
- "operational": false,
- "is_location_source": true,
- "is_preferred_fixed_source": false,
- "lock_version": 0,
- "device_details_restricted": false
}Ends the interval immediately, retaining history and the last-known vehicle position. The ended source cannot supply new positions. Repeating end is a no-op. Operational plugin restrictions still apply.
| association_id required | string <uuid> UUID of the device assignment episode, including ended episodes |
example
{- "id": "00000000-0000-4000-8000-000000000011",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "association_mode": "portable",
- "started_at": "2023-02-14T10:00:00Z",
- "ended_at": "2023-02-14T11:00:00Z",
- "operational": false,
- "is_location_source": false,
- "is_preferred_fixed_source": false,
- "lock_version": 1,
- "device_details_restricted": false
}Ended episodes remain addressable.
| association_id required | string <uuid> UUID of the device assignment episode, including ended episodes |
example
{- "id": "00000000-0000-4000-8000-000000000011",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "association_mode": "portable",
- "started_at": "2023-02-14T10:00:00Z",
- "operational": false,
- "is_location_source": true,
- "is_preferred_fixed_source": false,
- "lock_version": 0,
- "device_details_restricted": false
}Management updates may configure mode and fixed preference. A human with vehicles:device-location:use-self may instead change only is_location_source and lock_version for their proven current Device on an authorized Tour, using X-Device-Authorization. This path needs no vehicles:read grant and returns only the callerโs own association and source flags; it does not grant management reads. The source and preferred fixed Device are changed atomically; tracker/fixed priority and plugin work guards apply. An ended association conflicts. Source changes advance versions of affected associations.
| association_id required | string <uuid> Active VehicleโDevice association UUID |
| X-Device-Authorization | string Required for narrow current-Device source selection; omitted for management. Missing proof: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
| association_mode | string Enum: "fixed" "portable" |
| operational | boolean |
| is_location_source | boolean |
| is_preferred_fixed_source | boolean |
| lock_version | integer <int64> >= 0 |
select
{- "is_location_source": true,
- "lock_version": 0
}selected
{- "id": "00000000-0000-4000-8000-000000000011",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "association_mode": "portable",
- "started_at": "2023-02-14T10:00:00Z",
- "operational": false,
- "is_location_source": true,
- "is_preferred_fixed_source": false,
- "lock_version": 0,
- "device_details_restricted": false
}When events occur in Tourfold, webhook payloads are sent via HTTP POST to your configured endpoint URLs. Each delivery carries these headers:
v1,<base64> (see below).Deliveries are signed following the Standard Webhooks specification โ verify them with an official standardwebhooks library for your language, passing your endpoint's secret (the full whsec_... string) and the three webhook-* headers.
Verifying manually instead: the signature is an HMAC-SHA256 over the string {webhook-id}.{webhook-timestamp}.{raw_body} โ the three parts joined with a literal dot, where raw_body is the exact request body bytes as received (do not re-serialize the JSON). The HMAC key is the secret after stripping the whsec_ prefix and base64-decoding the remainder.
key = base64_decode( secret without the "whsec_" prefix )
signed_content = webhook_id + "." + webhook_timestamp + "." + raw_body
expected = "v1," + base64( hmac_sha256( key, utf8_bytes(signed_content) ) )
valid = constant_time_compare(expected, webhook_signature_header)
To protect against replay, also reject deliveries whose webhook-timestamp is outside your tolerance window (5 minutes is a common choice).
The secret is returned exactly once โ on endpoint creation and on secret rotation.
Every delivery has the same envelope: type (the event type), id, event_id, timestamp, payload_version, tenant_id, optional actor and request, and data. The resource itself is at data.object, and data.previous_attributes carries the old values of whatever an edit changed.
data.object always identifies the resource, and within one payload_version its fields are only ever added to โ never removed, renamed or retyped. Treat the key set as open and ignore keys you do not recognise.
Returns every event type this workspace can subscribe to, as <resource path>.<verb>.
Subscribe to exact names or to patterns: a trailing * after any path prefix (folder.*), a leading * for one verb across all resources (*.created), or * for everything. A wildcard verb widens the path to a prefix; a named verb pins it exactly โ so folder.* also matches folder.permissions.updated, while folder.updated does not.
The list is tenant-scoped because it includes one set of event types per object definition, which is the main reason to fetch it at runtime rather than hard-coding it.
EventTypes
{- "items": [
- {
- "type": "folder.updated",
- "resource_path": "folder",
- "verb": "updated"
}, - {
- "type": "folder.permissions.updated",
- "resource_path": "folder.permissions",
- "verb": "updated"
}, - {
- "type": "object.invoice.created",
- "resource_path": "object",
- "verb": "created",
- "object_slug": "invoice"
}
]
}Manage SMS gateway configurations per tenant. Gateways are evaluated by priority (0 = primary) for failover. Provider credentials are write-only: responses report them as *_configured flags and never return a value.
Returns gateways ordered by priority (0 = primary). Disabled gateways are included. Credentials are never returned; *_configured flags report whether one is stored.
GatewaysList
{- "items": [
- {
- "id": "11111111-2222-3333-4444-555555555555",
- "name": "Primary Twilio",
- "type": "TWILIO",
- "priority": 0,
- "enabled": true,
- "lock_version": 0,
- "twilio_config": {
- "username": "twilio-user-example",
- "account_sid": "AC00000000000000000000000000000000",
- "messaging_service_sid": "MG00000000000000000000000000000000",
- "phone_number": "+436641234567",
- "auth_token_configured": true,
- "account_auth_token_configured": true
}
}, - {
- "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "name": "Fallback Custom",
- "type": "CUSTOM_HTTP",
- "priority": 1,
- "enabled": false,
- "lock_version": 0,
- "custom_config": {
- "http_method": "POST",
- "content_type": "application/json",
- "auth_method": "API_KEY_HEADER",
- "api_key": {
- "header_name": "X-Api-Key",
- "header_value_configured": true
}, - "parameters": [
- {
- "key": "to",
- "place": "JSON_BODY",
- "type": "RECIPIENT"
}, - {
- "key": "text",
- "place": "JSON_BODY",
- "type": "MESSAGE_VALUE"
}
]
}
}
]
}Creates a tenant SMS gateway and returns its effective priority and configuration. Every credential of the chosen provider variant is required on create.
| enabled | boolean Whether delivery is enabled; defaults to true. |
| name required | string non-empty Operator-visible gateway name. |
| priority | integer <int32> >= 0 Zero-based failover position; omit to append. |
| type required | string Gateway provider kind; immutable after creation. |
required | object (TwilioGatewayConfig) Required Twilio credentials and sender configuration. |
CreateAlpineTwilioGateway
{- "name": "Alpine primary SMS",
- "type": "TWILIO",
- "priority": 0,
- "enabled": true,
- "twilio_config": {
- "username": "twilio-user-example",
- "auth_token": "twilio-auth-token-example",
- "account_sid": "AC00000000000000000000000000000000",
- "account_auth_token": "account-auth-token-example",
- "messaging_service_sid": "MG00000000000000000000000000000000",
- "phone_number": "+43 664 123 45 67"
}
}CreateTwilioGateway
{- "id": "11111111-2222-3333-4444-555555555555",
- "name": "Primary Twilio",
- "type": "TWILIO",
- "priority": 0,
- "enabled": true,
- "lock_version": 0,
- "twilio_config": {
- "username": "twilio-user-example",
- "account_sid": "AC00000000000000000000000000000000",
- "messaging_service_sid": "MG00000000000000000000000000000000",
- "phone_number": "+436641234567",
- "auth_token_configured": true,
- "account_auth_token_configured": true
}
}Sends a test message through the selected gateway synchronously and returns once the gateway has accepted it. Delivery-status updates for the returned tracking id arrive through the SMS_GATEWAY_TEST_RESULT:V1 server-sent event. The outcome is recorded in the SMS report either way.
| sms_gateway_id required | string <uuid> Gateway identifier |
| phone_number required | string non-empty International recipient number with an explicit '+' country code. Formatted input is normalized to E.164. |
SendTechnicianTestSms
{- "phone_number": "+436641234567"
}TestSmsSent
{- "tracking_id": "00000000-0000-4000-8000-000000004901"
}Reorders all gateways for the current tenant; request must list every gateway exactly once in the desired order (0 = primary).
| gateway_ids required | Array of strings <uuid> non-empty [ items <uuid > ] |
PrioritizeGateways
{- "gateway_ids": [
- "11111111-2222-3333-4444-555555555555",
- "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
]
}{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Returns the gateway configuration for the given ID. Credentials are never returned; *_configured flags report whether one is stored.
| sms_gateway_id required | string <uuid> Gateway identifier |
GatewayResponse
{- "id": "11111111-2222-3333-4444-555555555555",
- "name": "Primary Twilio",
- "type": "TWILIO",
- "priority": 0,
- "enabled": true,
- "lock_version": 0,
- "twilio_config": {
- "username": "twilio-user-example",
- "account_sid": "AC00000000000000000000000000000000",
- "messaging_service_sid": "MG00000000000000000000000000000000",
- "phone_number": "+436641234567",
- "auth_token_configured": true,
- "account_auth_token_configured": true
}
}Permanently removes the tenant SMS gateway.
| sms_gateway_id required | string <uuid> Gateway identifier |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Allows partial updates (name, enabled flag, priority). A provided configuration replaces the stored one; credentials omitted from it are kept, credentials provided in it are rotated.
| sms_gateway_id required | string <uuid> Gateway identifier |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check |
| name | string Display name of the gateway. Omitted leaves the value unchanged; explicit null is rejected (422) โ it cannot be cleared. |
| enabled | boolean Whether the gateway is enabled. Omitted leaves the value unchanged; explicit null is rejected (422) โ it cannot be cleared. |
| priority | integer <int32> Evaluation priority (0 = primary). Omitted leaves the value unchanged; explicit null is rejected (422) โ it cannot be cleared. |
object (TwilioGatewayConfig) Replaces the whole Twilio configuration when provided (gateway must be of type TWILIO). Omitted leaves the configuration unchanged; explicit null is rejected (422). Secret fields inside the configuration may be omitted to keep the stored values; a provided secret replaces (rotates) the stored one. | |
object or object or object or object (CustomSmsSettings) |
DisableGateway
{- "lock_version": 0,
- "enabled": false
}UpdateGateway
{- "id": "11111111-2222-3333-4444-555555555555",
- "name": "Renamed Gateway",
- "type": "TWILIO",
- "priority": 0,
- "enabled": false,
- "lock_version": 1,
- "twilio_config": {
- "username": "twilio-user-example",
- "account_sid": "AC00000000000000000000000000000000",
- "messaging_service_sid": "MG00000000000000000000000000000000",
- "phone_number": "+436641234567",
- "auth_token_configured": true,
- "account_auth_token_configured": true
}
}Creates many records across objects in one request, with sibling cross-linking via item key + relationship {ref}. The batch is atomic: all records are created in a single transaction, and any failure rolls back the whole batch. At most 100 items per request (422 above the limit).
required | Array of objects (BatchRecordItem) [ 1 .. 100 ] items Records to create, in order (1..100 items) | ||||||
Array ([ 1 .. 100 ] items)
| |||||||
Rtu17WithMaintenanceRequest
{- "items": [
- {
- "object": "maintenance_request",
- "key": "high_temp",
- "data": {
- "title": "Temperature too high on third floor",
- "priority": "urgent",
- "resolved": false
}
}, - {
- "object": "equipment",
- "key": "rtu17",
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "maintenance_requests": [
- {
- "ref": "high_temp"
}
]
}
}
]
}BatchResult
{- "records": [
- {
- "key": "high_temp",
- "object": "maintenance_request",
- "record": {
- "id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "definition_id": "22222222-9999-4444-8888-222222222222",
- "display_name": "Temperature too high on third floor",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-01T09:30:00Z",
- "lock_version": 0,
- "data": {
- "title": "Temperature too high on third floor",
- "priority": "urgent",
- "resolved": false
}
}
}, - {
- "key": "rtu17",
- "object": "equipment",
- "record": {
- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-01T09:30:00Z",
- "lock_version": 0,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "maintenance_requests": [
- {
- "record_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "object": "maintenance_request",
- "display_name": "Temperature too high on third floor"
}
]
}
}
}
]
}Lists an object's records (paged). The GET surface accepts only the declared pagination, sort, include, and canonical display-name search parameters. Use POST โฆ/records/query for all attribute filtering and boolean/reference composition. Sorting uses repeatable sort=<field>:asc|desc; the default is created_at:desc.
| object_ref required | string Object slug or UUID id. |
| page | integer [ 0 .. 21474836 ] Default: 0 Page number (0-based, max 21474836). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
| sort | Array of strings Example: sort=manufacturer.name:asc Repeated |
| include | Array of strings Example: include=maintenance_requests Relationship attributes to expand one level. Repeat |
| search | string [ 0 .. 256 ] characters Literal case-insensitive substring of canonical display_name, applied before count and pagination. Trims surrounding whitespace; blank returns 422. Percent and underscore are literal. Includes do not affect labels. Complex labels use bounded rendering under the query deadline. |
RecordPage
{- "items": [
- {
- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates one record for an object.
| object_ref required | string Object slug or UUID id. |
required | object Record data keyed by attribute slug | ||
| |||
CreateRtu17
{- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "category": "hvac",
- "maintenance_requests": [
- "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c"
]
}
}Rtu17Record
{- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "category": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "maintenance_requests": {
- "items": [
- {
- "record_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "object": "maintenance_request",
- "display_name": "Temperature too high on third floor"
}
], - "page": {
- "size": 50,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}
}
}Filters, sorts, and pages the records linked through one relationship attribute. Filters may traverse relationships up to four levels. Sorting accepts scalar fields and one to-one relationship path such as manufacturer.name:asc. The default is created_at:desc. Vehicle targets currently support the paginated related-record GET endpoint only; structured queries return 422.
| object_ref required | string Object slug or UUID id. |
| record_id required | string <uuid> Record id. |
| attribute_ref required | string Relationship attribute slug |
object Filter tree evaluated against the target collection's attributes (Vehicle families accept common fields only). Relationship filters may nest up to four levels. | |
| sort | Array of strings Sort clauses |
| page | integer <int32> [ 0 .. 21474836 ] Default: 0 Page number (0-based, max 21474836). |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Number of items per page (max 100). |
OpenRequestsByPriority
{- "filter": {
- "status": {
- "ne": "closed"
}
}, - "sort": [
- "assigned_team.name:asc",
- "created_at:desc"
], - "page": 0,
- "size": 20
}RecordPage
{- "items": [
- {
- "kind": "object",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "record": {
- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "category": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "maintenance_requests": {
- "items": [
- {
- "record_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "object": "maintenance_request",
- "display_name": "Temperature too high on third floor"
}
], - "page": {
- "size": 50,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}
}
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Powerful query for what GET โฆ/records query params can't express: and/or/not boolean composition and nested relationship / tagsยทskills sub-filters, using the same operator names (eq, ne, in, gt, gte, lt, lte, contains, starts_with, ends_with, is_null). filter grammar: keys at any level AND together; a leaf is { "<attribute>": { "<op>": <value>, โฆ } }; and/or take an array of nodes and not takes a single node; a relationship / reference attribute key takes a nested filter evaluated against the target object's attributes, including further relationship filters, and matches when at least one related record matches (an empty {} matches any related record). A comparison never matches an unset value, so ne and not include records whose value is unset. On a multi-select, in matches any of the values and contains all of them. Nesting is limited to 4 levels. Returns the same { items, page } envelope as GET โฆ/records.
| object_ref required | string Object slug or UUID id. |
| search | string [ 0 .. 256 ] characters Literal case-insensitive substring of the canonical display_name, combined with filter before count and pagination. Surrounding whitespace is trimmed; blank returns 422. Includes do not affect the label. Complex labels are rendered in bounded batches under the query deadline. |
object Filter tree keyed by attribute slug plus | |
| sort | Array of strings Sort clauses |
| include | Array of strings Relationship attributes to expand one level. Expansion adds the canonical target record under |
| page | integer <int32> [ 0 .. 21474836 ] Default: 0 Page number (0-based, max 21474836). |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Number of items per page (max 100). |
simple comparison
{- "filter": {
- "category": {
- "eq": "hvac"
}
}
}RecordPage
{- "items": [
- {
- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Fetches one record by id. Repeat include to expand named relationship pointers by one level. Expansion adds the target's canonical record under record; the compact record_id, object, and display_name fields remain present.
| object_ref required | string Object slug or UUID id. |
| record_id required | string <uuid> Record id. |
| include | Array of strings Example: include=maintenance_requests Relationship attributes to expand one level. Repeat |
Rtu17Record
{- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "category": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "maintenance_requests": {
- "items": [
- {
- "record_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "object": "maintenance_request",
- "display_name": "Temperature too high on third floor"
}
], - "page": {
- "size": 50,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}
}
}Deletes one record by id.
| object_ref required | string Object slug or UUID id. |
| record_id required | string <uuid> Record id. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON Merge Patch (RFC 7386): a key present in data sets it, an omitted key is unchanged, null clears an optional attribute, [] clears an edge set, and a location null clears the entire value. lock_version is validated when provided (409 on mismatch); omitting it skips the concurrency check.
| object_ref required | string Object slug or UUID id. |
| record_id required | string <uuid> Record id. |
object Partial record data keyed by attribute slug | |
| lock_version | integer or null <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
MarkOperational
{- "lock_version": 1,
- "data": {
- "operational": true
}
}Rtu17Record
{- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "category": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "maintenance_requests": {
- "items": [
- {
- "record_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "object": "maintenance_request",
- "display_name": "Temperature too high on third floor"
}
], - "page": {
- "size": 50,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}
}
}Lists the records linked to this record via the given relationship attribute, paged. Ordering is stable by record id (relationship edges carry no user-facing sort key).
| object_ref required | string Object slug or UUID id. |
| record_id required | string <uuid> Record id. |
| attribute_ref required | string Relationship attribute slug |
| page | integer [ 0 .. 21474836 ] Default: 0 Page number (0-based, max 21474836). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
RecordPage
{- "items": [
- {
- "kind": "object",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "record": {
- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "category": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "maintenance_requests": {
- "items": [
- {
- "record_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "object": "maintenance_request",
- "display_name": "Temperature too high on third floor"
}
], - "page": {
- "size": 50,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}
}
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Business-key lookup: returns the record whose unique {attribute_ref} equals the attribute_value query parameter without knowing its id. Requires {attribute_ref} to have config.is_unique: true (else 422). Attribute UUIDs and slugs are accepted. Text matches the stored key exactly; numeric values parse as decimals and choices accept their value or UUID.
| object_ref required | string Object slug or UUID id. |
| attribute_ref required | string Unique attribute slug or UUID |
| attribute_value required | string Value the unique attribute must equal. Query encoding preserves values containing URL path delimiters. |
Rtu17Record
{- "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
- "definition_id": "11111111-9999-4444-8888-111111111111",
- "display_name": "Rooftop HVAC Unit RTU-17 (AFS-RTU-17)",
- "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 1,
- "data": {
- "name": "Rooftop HVAC Unit RTU-17",
- "asset_tag": "AFS-RTU-17",
- "operational": false,
- "category": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "maintenance_requests": {
- "items": [
- {
- "record_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
- "object": "maintenance_request",
- "display_name": "Temperature too high on third floor"
}
], - "page": {
- "size": 50,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}
}
} Delete event tracking for CDC-style incremental sync with delete detection.
This endpoint allows external systems (e.g., Airbyte connectors) to poll for entity deletions
within a time range, enabling downstream systems to remove stale records.
Events are retained for 28 days before automatic cleanup.
Returns a paginated list of delete events within the specified time range.
Use this endpoint for CDC-style incremental sync to detect which entities have been deleted.
Events are sorted by `deleted_at` (ascending) with secondary sort by `id` for deterministic pagination.
**Cursor-based incremental sync:**
- Use `deleted_at` as the cursor field
- On first sync, use a `deleted_from` timestamp in the past and `deleted_to` as current time
- On subsequent syncs, use the last `deleted_at` value from the previous sync as the new `deleted_from`
| deleted_from required | string <date-time> Example: deleted_from=2024-01-01T00:00:00Z Lower bound for |
| deleted_to required | string <date-time> Example: deleted_to=2024-01-02T00:00:00Z Upper bound for |
| entity_type | string Example: entity_type=user Filter by entity type (e.g., user, vehicle, tour). If not specified, returns all entity types. |
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 1000 ] Default: 100 Example: size=100 Number of elements per page (max 1000). The cap is deliberately higher than the platform default of 100 because sync-style consumers replay deletions in bulk. |
DeletedEventsListResponse
{- "items": [
- {
- "id": "a1b2c3d4-e5f6-4a1b-8c9d-123456789abc",
- "entity_type": "user",
- "entity_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
- "deleted_at": "2024-01-01T12:00:00Z"
}, - {
- "id": "b2c3d4e5-f6a1-4b2c-9d8e-234567890bcd",
- "entity_type": "vehicle",
- "entity_id": "550e8400-e29b-41d4-a716-446655440000",
- "deleted_at": "2024-01-01T12:30:00Z"
}
], - "page": {
- "number": 0,
- "size": 100,
- "total_elements": 42,
- "total_pages": 1
}
}Retrieve audit logs with optional filters for time range, scope type, event type, and actor. The scope type / event type pairs recorded in this workspace are listed by listAuditLogEventTypes. Requires 'audit-logs:read' grant.
| occurred_from | string <date-time> Example: occurred_from=2024-01-01T00:00:00Z Lower bound for event occurrence time (inclusive, RFC 3339). Defaults to 1 day ago. |
| occurred_to | string <date-time> Example: occurred_to=2024-12-31T23:59:59Z Upper bound for event occurrence time (exclusive, RFC 3339). Defaults to now. |
| scope_type | string Example: scope_type=USER Filter by scope type, the kind of entity an event applies to (e.g. USER, TENANT, DEVICE). Recorded values are listed by |
| scope_id | string Example: scope_id=00000000-0000-4000-8000-000000001002 Filter by the ID of the affected entity (e.g., specific user ID, tour ID, case ID) |
| event_type | string Example: event_type=USER_CREATED Filter by event type (e.g. USER_CREATED, BRAND_UPDATED). Recorded values are listed by |
| actor_id | string Example: actor_id=00000000-0000-4000-8000-000000001001 Filter by the ID of the actor who performed the action |
| page | integer >= 0 Default: 0 Page number (0-based). First page is 0. |
| size | integer [ 1 .. 1000 ] Default: 50 Example: size=50 Number of items per page. Maximum allowed is 1000. |
| sort | Array of strings Example: sort=scope_type:asc Repeated sorting criteria in |
AuditLogsResponse
{- "items": [
- {
- "id": "f8c1b4b5-ffe8-4d1c-8f0a-8c55e7b9c6d1",
- "original_event_time": "2026-08-20T08:05:00Z",
- "scope_type": "USER",
- "scope_id": "00000000-0000-4000-8000-000000001002",
- "event_type": "USER_CREATED",
- "description": "Mara Berger created Jonas Leitner",
- "data": {
- "actor_email": "mara.berger@example.invalid"
}, - "actor_id": "00000000-0000-4000-8000-000000001001",
- "origin": "APPLICATION"
}, - {
- "id": "a83f3f6c-6d3b-4f3a-89d7-1d3c9d0f1c2b",
- "original_event_time": "2026-08-20T08:10:00Z",
- "scope_type": "TENANT",
- "scope_id": "00000000-0000-4000-8000-000000000101",
- "event_type": "TENANT_CREATED",
- "description": "Alpine workspace activated the Scale plan",
- "data": {
- "plan": "scale",
- "actor": "system"
}, - "origin": "APPLICATION"
}
], - "page": {
- "size": 50,
- "total_elements": 2,
- "total_pages": 1,
- "number": 0
}
}List the distinct scope type / event type pairs recorded in this workspace's audit log, for building the scope_type and event_type filter choices of listAuditLogs. Requires 'audit-logs:read' grant.
AuditLogEventTypesResponse
{- "items": [
- {
- "scope_type": "BRAND",
- "event_type": "BRAND_CREATED"
}, - {
- "scope_type": "BRAND",
- "event_type": "BRAND_UPDATED"
}, - {
- "scope_type": "TENANT",
- "event_type": "TENANT_CREATED"
}, - {
- "scope_type": "USER",
- "event_type": "USER_CREATED"
}
]
}The workspace's provider accounts (DRVN, High Mobility) as Vehicle connections name them. Their configuration and credentials are managed in the workspace settings.
Every provider account of the workspace, ordered by name, disabled ones included. An account's id is the provider_account_id that connects a Vehicle through it. Needs connected-vehicle-providers:read, connected-vehicle-providers:write or connected-vehicles:create, and the connected-vehicles entitlement.
accounts
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000101",
- "name": "DRVN UAT",
- "provider": "DRVN",
- "environment": "UAT",
- "enabled": true
}, - {
- "id": "00000000-0000-4000-8000-000000000102",
- "name": "HM sandbox",
- "provider": "HIGH_MOBILITY",
- "environment": "SANDBOX",
- "enabled": false
}
]
}Requires tours:read, or tours:read-own for published tours containing the current human user. planned_start_from is inclusive and planned_start_to exclusive.
| search | string Literal description substring or exact positive tour number |
| natural_id | integer <int64> >= 1 Exact human tour number |
| participant_user_id | string <uuid> Exact participant UUID |
| publication_status | string Enum: "draft" "published" Publication state |
| execution_status | string Enum: "not_started" "in_progress" "finished" Execution state |
| planned_start_from | string <date-time> Inclusive planned-start boundary, RFC 3339 |
| planned_start_to | string <date-time> Exclusive planned-start boundary, RFC 3339 |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Page size |
| sort | string Default: "natural_id:desc" Enum: "planned_start_at" "planned_start_at:asc" "planned_start_at:desc" "natural_id" "natural_id:asc" "natural_id:desc" "description" "description:asc" "description:desc" "created_at" "created_at:asc" "created_at:desc" "updated_at" "updated_at:asc" "updated_at:desc" "id" "id:asc" "id:desc" One field[:asc|desc]: planned_start_at, natural_id, description, created_at, updated_at, id; newest tour number first by default; stable id tie-breaker. Drafts without a start sort last ascending. |
Success
{- "items": [
- {
- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "draft",
- "execution_status": "not_started",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "vehicles": [ ]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Requires tours:create. Resolves the named template, or Default for omitted/null tour_template_id, and copies its latest content. Named templates require tour-templates:read and tour_date. Default requires tour_date only for inherited relative planned times. Tasks require tasks:write. Initial vehicles require tours:update plus readable Tour/Vehicle scope; busy Vehicles require per-selection acknowledge_active_use. Numbers are allocated by the server and are never reused.
| tour_template_id required | string <uuid> Named Tour template UUID; omitted/null applies the protected Default |
| tour_date required | string <date> Calendar date in the template timezone; required for a named template or inherited relative times |
| description | string or null [ 1 .. 255 ] characters Omitted inherits; null leaves unset |
| participant_user_ids | Array of strings <uuid> <= 100 items unique [ items <uuid > ] Active human users only; defaults to empty. Unique, at most 100. |
| planned_start_at | string or null <date-time> Absolute RFC 3339 timestamp; omission inherits, null leaves unset |
| planned_end_at | string or null <date-time> Absolute RFC 3339 timestamp; omission inherits, null leaves unset. Must be after the final start when both are set |
| required_skill_ids | Array of strings <uuid> <= 1000 items unique [ items <uuid > ] Omission inherits required skills; [] clears them |
Array of objects (TourVehicleSelection) <= 100 items Initial Vehicle assignments; at most 100 unique Vehicles. Requires Tour Vehicle management and Vehicle read authority. |
Request
{- "description": "Morning visits"
}Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "draft",
- "execution_status": "not_started",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "vehicles": [ ]
}Requires an active Tour, Vehicle read permission and tours:update, or tours:vehicles:assign-own for a participant with Tour read access. Tour execution permission is not required. Device source selection additionally requires devices:vehicles:assign-self and vehicles:device-location:use-self unless configured hardware already supplies location. Coordinates assignment, actual use, participant cleanup and source selection atomically. Device proof supplies the exact observed association. Other active Vehicle use conflicts.
| tour_id required | string <uuid> Tour UUID |
| X-Device-Authorization | string Required when device_context is supplied; omitted for dispatcher commands without Device context. Missing proof: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
| lock_version | integer or null <int64> >= 0 |
required | object (TourVehicleUse) |
object (TourDeviceContext) |
Request
{- "vehicle_use": {
- "vehicle_id": "00000000-0000-4000-8000-000000000027"
}
}Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "published",
- "published_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:01:00Z",
- "execution_status": "in_progress",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "vehicles": [ ]
}Requires tours:update or tours:execute-own for a participant. Publish first; every participant and Vehicle must be free of another active tour. Membership, portable cleanup, fixed-Device human session revocation and source selection commit atomically. Device proof requires exact observed episode context. Repeating an already-active Start succeeds only when the requested intent already holds; different Vehicle or source intent conflicts and requires use-vehicle.
| tour_id required | string <uuid> Tour UUID |
| X-Device-Authorization | string Required when device_context is supplied; omitted for dispatcher commands without Device context. Missing proof: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
| lock_version | integer or null <int64> >= 0 |
object (TourVehicleUse) | |
object (TourDeviceContext) |
Request
{- "lock_version": 0,
- "device_context": {
- "expected_vehicle_association_id": null
}
}Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "published",
- "published_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:01:00Z",
- "execution_status": "in_progress",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "vehicles": [ ]
}Requires tours:update. At least one participant is required. Planned start and end are optional.
| tour_id required | string <uuid> Tour UUID |
| lock_version | integer or null <int64> >= 0 Omitted or null skips the precondition; stale versions return 409. |
Request
{- "lock_version": 0
}Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "published",
- "published_at": "2023-02-14T10:00:00Z",
- "execution_status": "not_started",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "vehicles": [ ]
}Requires tours:update or tours:execute-own for a participant. All tasks and standalone stops must be done; nothing is completed implicitly.
| tour_id required | string <uuid> Tour UUID |
| lock_version | integer or null <int64> >= 0 Omitted or null skips the precondition; stale versions return 409. |
Request
{- "lock_version": 0
}Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "published",
- "published_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:01:00Z",
- "finished_at": "2023-02-14T11:00:00Z",
- "execution_status": "finished",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "vehicles": [ ]
}Requires tours:start-ad-hoc and an active human user. Resolves one effective template (Default for omitted/null tour_template_id), then creates, publishes and starts the Tour and its work atomically. Named templates additionally require tour-templates:read; templates with Tasks require tasks:write. Omitted tour_date uses the template timezone and the command clock. Optional Vehicle use and proven Device context follow the same atomic coordination as planned Start. An active participant conflict includes data.tour_id.
| X-Device-Authorization | string Required when device_context is supplied; omitted for dispatcher commands without Device context. Missing proof: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
object (TourVehicleUse) | |
object (TourDeviceContext) | |
| tour_template_id | string or null <uuid> Named template UUID; omitted/null applies Default |
| tour_date | string or null <date> Calendar date in the template timezone; omission derives it from the command clock |
| description | string or null [ 1 .. 255 ] characters Omission inherits; null leaves unset |
| planned_start_at | string or null <date-time> Omission inherits; null leaves unset |
| planned_end_at | string or null <date-time> Omission inherits; null leaves unset |
| required_skill_ids | Array of strings <uuid> <= 1000 items unique [ items <uuid > ] Omission inherits; [] clears requirements |
Request
{- "description": "Ad-hoc visits"
}Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "published_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:00:00Z",
- "origin": "ad_hoc",
- "publication_status": "published",
- "execution_status": "in_progress",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "vehicles": [ ]
}Requires tours:read or tours:read-own for a published Tour containing the current user. include=stops returns Stops without Task arrays or identifiers; include=tasks also returns ordered nested/root Tasks and assignment versions. Repeat include to combine; tasks implies stops. Task expansion and Task-derived Stop destinations require tasks:read. A denied expansion fails completely with 403 access-denied, reason missing_grant and required_grants [tasks:read]. One consistent snapshot; at most 500 Stops and 10,000 Tasks plus Stops. No include retains the summary.
| tour_id required | string <uuid> Tour UUID |
| include | Array of strings non-empty Items Enum: "stops" "tasks" Opt-in expansion depth; repeat for multiple values. Comma-separated values are invalid. |
Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "draft",
- "execution_status": "not_started",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "vehicles": [ ]
}Requires tours:delete and tours:update. Atomically unassigns and preserves its tasks, then removes its stops. Started tours cannot be deleted.
| tour_id required | string <uuid> Tour UUID |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Requires tours:update, or tours:execute-own for an ad-hoc Tour containing the current user. A Vehicle-only update also permits tours:vehicles:assign-own for a participant with Tour read access. Vehicle assignments additionally require vehicles:read; newly added Vehicles must use an eligible definition. Replaces the complete Vehicle list; per-selection acknowledge_active_use acknowledges active use elsewhere for future planning, never concurrent actual use. Active changes reconcile participant Devices atomically. Type, identity and lifecycle are server controlled.
| tour_id required | string <uuid> Tour UUID |
| description | string or null [ 1 .. 255 ] characters Omission preserves the description; null clears it. Blank strings are rejected. |
| participant_user_ids | Array of strings <uuid> <= 100 items unique [ items <uuid > ] Replaces the complete participant set. |
| planned_start_at | string or null <date-time> Omission preserves the planned start; null clears it before the tour starts. |
| planned_end_at | string or null <date-time> Omission preserves the planned end; null clears it until the tour finishes. Must be after planned_start_at when both are set. |
| required_skill_ids | Array of strings <uuid> <= 1000 items unique [ items <uuid > ] Replace authored required skills; omission preserves, [] clears. The system Vehicle requirement blocks first Start without an eligible Vehicle; other missing skills are advisory |
Array of objects (TourVehicleSelection) <= 100 items Complete intended Vehicle set; omission preserves, [] removes all. Maximum 100 unique Vehicles. | |
| lock_version | integer or null <int64> >= 0 Omitted or null skips the precondition; stale versions return 409. |
Request
{- "description": "Afternoon visits",
- "lock_version": 0
}Success
{- "id": "2aeb50b2-a41c-4a5f-a498-7651a0938522",
- "natural_id": 1,
- "required_skill_ids": [ ],
- "stop_count": 0,
- "task_count": 0,
- "description": "Morning visits",
- "participant_user_ids": [
- "b8746c3e-2ea1-4939-981b-d68777dc611a"
], - "planned_start_at": "2023-02-14T10:00:00Z",
- "origin": "planned",
- "publication_status": "draft",
- "execution_status": "not_started",
- "created_by_user_id": "b8746c3e-2ea1-4939-981b-d68777dc611a",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "vehicles": [ ]
}Requires Tours read, own read, create, ad-hoc Start or update authority, tour-templates:read, or tenant:settings:update. Returns the protected Default template, system Vehicle skill, exclusions and settings version without granting template listing or editing.
Default
{- "default_tour_template_id": "a46c234e-f8ba-42ad-955e-f103d514df76",
- "vehicle_skill_id": "5a6970f9-9860-43cb-8c41-85e27f9c202b",
- "excluded_vehicle_definition_ids": [ ],
- "lock_version": 0
}Requires tenant:settings:update. Replace excluded Vehicle definitions; omission preserves, [] permits all and null is invalid. Existing active assignments continue; first Start and new assignments recheck exclusions.
| excluded_vehicle_definition_ids | Array of strings <uuid> <= 1000 items unique [ items <uuid > ] Complete exclusion set of up to 1000 unique Vehicle definition UUIDs; [] clears |
| lock_version | integer or null <int64> >= 0 Optional settings version; omission/null skips the precondition |
ClearExclusions
{- "excluded_vehicle_definition_ids": [ ],
- "lock_version": 0
}AllDefinitions
{- "default_tour_template_id": "a46c234e-f8ba-42ad-955e-f103d514df76",
- "vehicle_skill_id": "5a6970f9-9860-43cb-8c41-85e27f9c202b",
- "excluded_vehicle_definition_ids": [ ],
- "lock_version": 0
}Requires tours:read or tours:read-own for a published Tour containing the current user. lifecycle=current (default) selects removed_at absent, including finished use; all includes removed episodes. Fixed assigned_at descending, id ascending order. Vehicle labels are current, not historical, and omitted without vehicles:read. Assignment and Vehicle identities remain visible. No write operations are offered on this collection.
| tour_id required | string <uuid> Tour UUID |
| lifecycle | string Default: "current" Enum: "current" "all" Current membership or all retained episodes |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Page size |
Empty
{- "items": [ ],
- "page": {
- "size": 20,
- "total_elements": 0,
- "total_pages": 0,
- "number": 0
}
}Read-only discovery with explicit resource ownership; author through resource-specific definition APIs
Includes supported native schemas without making them editable Objects. Owner visibility is applied before pagination. Includes concrete Object, Vehicle and Task definitions and supported native projections. Internal Vehicle and Task family roots are excluded. Results are ordered by slug, then ID.
| page | integer <int32> >= 0 Default: 0 Zero-based page number |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Page size |
| If-None-Match | string Optional ETag for conditional revalidation |
Empty
{- "items": [ ],
- "page": {
- "size": 20,
- "total_elements": 0,
- "total_pages": 0,
- "number": 0
}
}Returns logical fields and ownership for a supported definition identified by slug or UUID. The owning resource controls metadata access. Discovery does not grant record access or make native schemas editable through Object APIs.
| definition_ref required | string Definition slug or UUID |
| If-None-Match | string Optional ETag for conditional revalidation |
Tag
{- "id": "cccebcdf-0de1-4a45-ac74-47fa9bd4b27b",
- "slug": "tag",
- "resource_type": "tag",
- "name": {
- "en": {
- "singular": "Tag",
- "plural": "Tags"
}
}, - "attributes": [ ],
- "managed_by": "system",
- "schema_policy": "locked",
- "is_readonly": true,
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Lists all workspace roles with enabled grants and a can_assign indicator. Visibility does not imply assignability. System roles sort first, then name and id ascending.
| search | string Example: search=dispatcher Case-insensitive partial match on role name. |
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
RolesResponse
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000001101",
- "name": "technician",
- "description": "Field technicians who maintain customer equipment.",
- "grants": [
- "users:read",
- "users:update"
], - "assignable_by_roles": [
- "00000000-0000-4000-8000-000000001100"
], - "member_count": 1,
- "can_assign": true,
- "editable": true,
- "is_system_role": false,
- "requires_second_factor": false,
- "lock_version": 0
}, - {
- "id": "00000000-0000-4000-8000-000000001100",
- "name": "owner",
- "description": "Full access to everything in the workspace.",
- "grants": [
- "users:read"
], - "assignable_by_roles": [ ],
- "member_count": 1,
- "can_assign": false,
- "editable": false,
- "is_system_role": true,
- "requires_second_factor": false,
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 2,
- "total_pages": 1,
- "number": 0
}
}Creates a role with the provided grants. New grants the caller does not possess are rejected. System-only and hidden login grants cannot be edited through this API.
| name required | string non-empty Role name |
| grants required | Array of strings unique List of grants enabled for this role |
| assignable_by_roles required | Array of strings <uuid> non-empty unique [ items <uuid > ] Role IDs that are allowed to assign this role |
| description | string Optional role description |
| requires_second_factor | boolean When true, users holding this role must complete a second-factor challenge (currently a login PIN) at login. Defaults to false when omitted. |
CreateTechnicianRole
{- "name": "technician",
- "grants": [
- "users:read",
- "users:update"
], - "assignable_by_roles": [
- "00000000-0000-4000-8000-000000001100"
], - "description": "Field technicians who maintain customer equipment."
}CreateRoleResponse
{- "id": "00000000-0000-4000-8000-000000001101",
- "name": "technician",
- "description": "Field technicians who maintain customer equipment.",
- "grants": [
- "users:read",
- "users:update"
], - "assignable_by_roles": [
- "00000000-0000-4000-8000-000000001100"
], - "member_count": 1,
- "can_assign": true,
- "editable": true,
- "is_system_role": false,
- "requires_second_factor": false,
- "lock_version": 0
}Returns a single role by its unique identifier.
| role_id required | string <uuid> Example: 4b3c2d1e-9a8b-4c6d-8e0f-1234567890ab UUID of the role to retrieve |
RoleResponse
{- "id": "00000000-0000-4000-8000-000000001101",
- "name": "technician",
- "description": "Field technicians who maintain customer equipment.",
- "grants": [
- "users:read",
- "users:update"
], - "assignable_by_roles": [
- "00000000-0000-4000-8000-000000001100"
], - "member_count": 1,
- "can_assign": true,
- "editable": true,
- "is_system_role": false,
- "requires_second_factor": false,
- "lock_version": 0
}Deletes a role by its unique identifier.
| role_id required | string <uuid> UUID of the role. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON Merge Patch (RFC 7386): omitted fields remain unchanged; a field set to null is cleared (description). New grants the caller does not possess are rejected; existing grants outside their control are preserved even when omitted from the replacement grants set. System-only and hidden login grants cannot be edited.
| role_id required | string <uuid> UUID of the role. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check |
| name | string Role name. Omitted leaves the value unchanged. Explicit null is rejected (422) โ name is required and cannot be cleared. |
| grants | Array of strings unique List of grants enabled for this role; replaces the full grant set when provided. Omitted leaves the value unchanged. Explicit null is rejected (422). |
| assignable_by_roles | Array of strings <uuid> unique [ items <uuid > ] Role IDs that are allowed to assign this role; replaces the full set when provided. Omitted leaves the value unchanged. Explicit null is rejected (422). |
| description | string or null Optional role description. Omitted leaves the value unchanged; explicit null clears it. |
| requires_second_factor | boolean or null When true, users holding this role must complete a second-factor challenge (currently a login PIN) at login. Omitted leaves the value unchanged. |
UpdateRoleNull
{- "name": "technician",
- "description": null
}UpdateRoleResponse
{- "id": "00000000-0000-4000-8000-000000001101",
- "name": "technician",
- "description": "Field technicians who maintain customer equipment.",
- "grants": [
- "users:read",
- "users:update"
], - "assignable_by_roles": [
- "00000000-0000-4000-8000-000000001100"
], - "member_count": 1,
- "can_assign": true,
- "editable": true,
- "is_system_role": false,
- "requires_second_factor": false,
- "lock_version": 0
}Returns a paginated list of tags. Available to all authenticated users.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
AlpineTagsPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20",
- "created_at": "2026-08-20T08:15:00Z",
- "updated_at": "2026-08-20T08:15:00Z",
- "lock_version": 0,
- "usage_count": 1
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a new tag. Requires 'tags:create' grant.
| name required | string non-empty Tag name |
| color required | string non-empty Tag color (hex or CSS color value) |
CreateUrgentTag
{- "name": "urgent",
- "color": "#D92D20"
}CreatedUrgentTag
{- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20",
- "created_at": "2026-08-20T08:15:00Z",
- "updated_at": "2026-08-20T08:15:00Z",
- "lock_version": 0,
- "usage_count": 1
}Returns a single tag by its ID. Available to all authenticated users.
| tag_id required | string <uuid> UUID of the tag. |
UrgentTag
{- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20",
- "created_at": "2026-08-20T08:15:00Z",
- "updated_at": "2026-08-20T08:15:00Z",
- "lock_version": 0,
- "usage_count": 1
}Deletes a tag by ID. Requires 'tags:update' grant.
| tag_id required | string <uuid> UUID of the tag. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Partial update: omitted fields remain unchanged. Requires 'tags:update' grant.
| tag_id required | string <uuid> UUID of the tag. |
| name | string Tag name. Omit to leave the value unchanged. Must not be null or blank. |
| color | string Tag color (hex or CSS color value). Omit to leave the value unchanged. Must not be null or blank. |
| lock_version | integer or null <int64> Optimistic lock version. If provided, the update will fail with 409 if the stored version does not match. |
UpdateUrgentTagColor
{- "color": "#B42318",
- "lock_version": 0
}UpdatedUrgentTag
{- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#B42318",
- "created_at": "2026-08-20T08:15:00Z",
- "updated_at": "2026-08-20T09:15:00Z",
- "lock_version": 1,
- "usage_count": 1
}Requires tour-templates:read. Counts and skill IDs are included without loading every template's contents.
| search | string [ 1 .. 255 ] characters Nonblank literal name substring |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Page size |
| sort | string Default: "name:asc" One field[:asc|desc]: name, created_at, updated_at or id. Defaults to name:asc with stable UUID tie-breaker. |
Success
{- "items": [ ],
- "page": {
- "size": 20,
- "total_elements": 0,
- "total_pages": 0,
- "number": 0
}
}Requires tour-templates:create. Saves the entire validated aggregate atomically, including definition-bound custom Task inputs. Template item UUIDs may be supplied by the editor; operational resources are created only when the template is used.
| name required | string [ 1 .. 255 ] characters |
required | object (TourTemplateTourDefaultsWrite) |
Array of any (TourTemplateTaskWrite) [ 0 .. 10000 ] items | |
Array of objects (TourTemplateStopWrite) [ 0 .. 500 ] items | |
Array of any (TourTemplateOrderItemWrite) [ 0 .. 10000 ] items |
Request
{- "name": "Morning inspection",
- "tour_defaults": {
- "timezone": "Europe/Vienna"
}, - "tasks": [ ],
- "stops": [ ],
- "items": [ ]
}Success
{- "id": "a46c234e-f8ba-42ad-955e-f103d514df76",
- "name": "Morning inspection",
- "is_default": false,
- "tour_defaults": {
- "timezone": "Europe/Vienna",
- "required_skill_ids": [ ]
}, - "tasks": [ ],
- "stops": [ ],
- "items": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "needs_configuration": false
}Requires tour-templates:read, or tours:create/tours:start-ad-hoc for the protected Default only. Returns complete saved contents, custom Task inputs, configuration repair fields and order; bounded Default access grants no listing, editing or named-template reads.
| tour_template_id required | string <uuid> Template UUID |
Success
{- "id": "a46c234e-f8ba-42ad-955e-f103d514df76",
- "name": "Morning inspection",
- "is_default": false,
- "tour_defaults": {
- "timezone": "Europe/Vienna",
- "required_skill_ids": [ ]
}, - "tasks": [ ],
- "stops": [ ],
- "items": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "needs_configuration": false
}Requires tour-templates:delete. The protected Default and current workflow references block deletion. Generated Tours remain independent; historical or origin-only references do not block deletion.
| tour_template_id required | string <uuid> Template UUID |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Requires tour-templates:update. Nested defaults merge; supplied arrays replace completely. Omitted lock_version skips the precondition. Saving does not change previously created Tours.
| tour_template_id required | string <uuid> Template UUID |
| name | string [ 1 .. 255 ] characters |
object (UpdateTourTemplateTourDefaults) | |
Array of any (TourTemplateTaskWrite) <= 10000 items | |
Array of objects (TourTemplateStopWrite) <= 500 items | |
Array of any (TourTemplateOrderItemWrite) <= 10000 items | |
| lock_version | integer or null <int64> >= 0 Optional optimistic concurrency check |
Request
{- "name": "Morning inspection",
- "tour_defaults": {
- "description": null
}, - "lock_version": 0
}Success
{- "id": "a46c234e-f8ba-42ad-955e-f103d514df76",
- "name": "Morning inspection",
- "is_default": false,
- "tour_defaults": {
- "timezone": "Europe/Vienna",
- "required_skill_ids": [ ]
}, - "tasks": [ ],
- "stops": [ ],
- "items": [ ],
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "needs_configuration": false
}Returns a paginated list of skills.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
| sort | Array of strings Example: sort=name:asc Repeated sorting criteria in |
| search | string Search term matched against name and short_key. |
| updated_from | string <date-time> Lower bound for |
| updated_to | string <date-time> Upper bound for |
SkillsResponse
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000006001",
- "created_at": "2026-08-20T08:12:00Z",
- "updated_at": "2026-08-20T08:12:00Z",
- "name": "HVAC maintenance",
- "short_key": "HVAC",
- "managed_by": "tenant",
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a new skill with the provided information
| name required | string [ 0 .. 255 ] characters Skill name |
| short_key required | string [ 0 .. 6 ] characters Short key, unique in the workspace (case-insensitive) |
CreateHvacMaintenanceSkill
{- "name": "HVAC maintenance",
- "short_key": "HVAC"
}SkillResponse
{- "id": "00000000-0000-4000-8000-000000006001",
- "name": "HVAC maintenance",
- "short_key": "HVAC",
- "managed_by": "tenant",
- "created_at": "2026-08-20T08:12:00Z",
- "updated_at": "2026-08-20T08:12:00Z",
- "lock_version": 0
}Retrieves a specific skill by its ID
| skill_id required | string <uuid> UUID of the skill. |
SkillsResponse
{- "id": "00000000-0000-4000-8000-000000006001",
- "created_at": "2026-08-20T08:12:00Z",
- "updated_at": "2026-08-20T08:12:00Z",
- "name": "HVAC maintenance",
- "short_key": "HVAC",
- "managed_by": "tenant",
- "lock_version": 0
}Deletes a skill by its ID
| skill_id required | string <uuid> UUID of the skill. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Partial update: omitted fields remain unchanged (JSON Merge Patch, RFC 7386).
| skill_id required | string <uuid> UUID of the skill. |
| name | string Skill name (max 255 characters). Omitted leaves the value unchanged; explicit null is rejected (422) โ it is required and cannot be cleared. |
| short_key | string Short key identifier (max 10 characters). Omitted leaves the value unchanged; explicit null is rejected (422) โ it is required and cannot be cleared. |
| lock_version | integer or null <int64> Optimistic-locking version of the skill: validated when provided (409 on mismatch); omitting it skips the concurrency check |
UpdateSkillName
{- "lock_version": 2,
- "name": "Advanced HVAC maintenance"
}UpdateSkillResponse
{- "id": "00000000-0000-4000-8000-000000006001",
- "name": "HVAC maintenance",
- "short_key": "HVAC",
- "managed_by": "tenant",
- "created_at": "2026-08-20T08:12:00Z",
- "updated_at": "2026-08-20T08:12:00Z",
- "lock_version": 0
}Returns invoice summaries for Stripe-backed self-service tenants. Other plan kinds return an empty list. Stripe is the source of truth: the service fetches a bounded window of the most recent 100 invoices from Stripe and page/size paginate over that fetched window (newest first). page.total_elements therefore never exceeds 100 even if Stripe holds more history.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
AlpineInvoicesPage
{- "items": [
- {
- "id": "in_alpine_2026_08",
- "number": "AFS-2026-08",
- "status": "paid",
- "currency": "eur",
- "amount_due": 12900,
- "amount_paid": 12900,
- "amount_remaining": 0,
- "created_at": "2026-08-01T08:00:00Z",
- "period_start": "2026-08-01T00:00:00Z",
- "period_end": "2026-09-01T00:00:00Z"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Returns the Stripe invoice PDF URL after verifying the invoice belongs to this tenant's Stripe customer.
| invoice_id required | string Identifier of the invoice. |
AlpineInvoiceDownload
Returns a page of webhook endpoints configured for the current tenant. Pass object_id to return only endpoints whose stored subscription explicitly names that object definition.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
| object_id | string <uuid> Example: object_id=6b1e0f22-0000-4000-8000-000000000001 Return only endpoints holding a subscription scoped to this object. Broader patterns such as |
AlpineWebhookEndpointsPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000008001",
- "display_name": "Alpine maintenance integration",
- "signature_scheme": "HMAC_SHA256",
- "enabled": true,
- "retry": true,
- "subscriptions": [
- "device.updated",
- "user.updated"
], - "invalid_subscriptions": [ ],
- "created_at": "2026-08-20T08:40:00Z",
- "updated_at": "2026-08-20T08:40:00Z",
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a webhook endpoint with optional subscriptions and returns the generated secret once.
| display_name required | string [ 1 .. 255 ] characters Human readable endpoint name |
| endpoint_url required | string <uri> [ 1 .. 2048 ] characters ^https?://.+$ HTTPS destination URL. Plain HTTP is accepted only when the server's explicit local-development escape hatch is enabled. |
| signature_scheme | string Default: "HMAC_SHA256" Value: "HMAC_SHA256" Signature scheme |
| enabled | boolean Default: true Whether deliveries are enabled |
| retry | boolean Default: true Whether failed deliveries should be retried |
| subscriptions | Array of strings [ 0 .. 100 ] items [ items <= 512 characters ] Webhook event types to subscribe to |
CreateAlpineIntegrationEndpoint
{- "display_name": "Alpine maintenance integration",
- "signature_scheme": "HMAC_SHA256",
- "enabled": true,
- "retry": true,
- "subscriptions": [
- "device.updated",
- "user.updated"
]
}CreatedAlpineIntegrationEndpoint
{- "id": "00000000-0000-4000-8000-000000008001",
- "display_name": "Alpine maintenance integration",
- "signature_scheme": "HMAC_SHA256",
- "enabled": true,
- "retry": true,
- "subscriptions": [
- "device.updated",
- "user.updated"
], - "invalid_subscriptions": [ ],
- "created_at": "2026-08-20T08:40:00Z",
- "updated_at": "2026-08-20T08:40:00Z",
- "lock_version": 0,
- "secret": "whsec_example_not_a_real_secret"
}Rotates and returns a new secret. The previous secret is invalidated. The change takes effect immediately and the operation takes no request body.
| endpoint_id required | string <uuid> UUID of the webhook endpoint. |
RotatedAlpineIntegrationSecret
{- "id": "00000000-0000-4000-8000-000000008001",
- "display_name": "Alpine maintenance integration",
- "signature_scheme": "HMAC_SHA256",
- "enabled": true,
- "retry": true,
- "subscriptions": [
- "device.updated",
- "user.updated"
], - "invalid_subscriptions": [ ],
- "created_at": "2026-08-20T08:40:00Z",
- "updated_at": "2026-08-20T09:45:00Z",
- "lock_version": 2,
- "secret": "whsec_rotated_example_not_a_real_secret"
}Returns one webhook endpoint configured for the current tenant. The signing secret is never returned.
| endpoint_id required | string <uuid> UUID of the webhook endpoint. |
AlpineIntegrationEndpoint
{- "id": "00000000-0000-4000-8000-000000008001",
- "display_name": "Alpine maintenance integration",
- "signature_scheme": "HMAC_SHA256",
- "enabled": true,
- "retry": true,
- "subscriptions": [
- "device.updated",
- "user.updated"
], - "invalid_subscriptions": [ ],
- "created_at": "2026-08-20T08:40:00Z",
- "updated_at": "2026-08-20T08:40:00Z",
- "lock_version": 0
}Deletes a webhook endpoint and all its subscriptions.
| endpoint_id required | string <uuid> UUID of the webhook endpoint. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Partial update: omitted fields remain unchanged. Include subscriptions to replace them, or omit to keep existing subscriptions.
| endpoint_id required | string <uuid> UUID of the webhook endpoint. |
| display_name | string [ 1 .. 255 ] characters Human readable endpoint name. Omitted leaves the value unchanged. Explicit null and blank strings are rejected (422). |
| endpoint_url | string <uri> [ 1 .. 2048 ] characters HTTPS destination URL. Plain HTTP is accepted only when the server's explicit local-development escape hatch is enabled. Omitted leaves the value unchanged. Explicit null and blank strings are rejected (422). |
| signature_scheme | string Value: "HMAC_SHA256" Signature scheme. Omitted leaves the value unchanged. Explicit null is rejected (422). |
| enabled | boolean Whether deliveries are enabled. Omitted leaves the value unchanged. Explicit null is rejected (422). |
| retry | boolean Whether failed deliveries should be retried. Omitted leaves the value unchanged. Explicit null is rejected (422). |
| subscriptions | Array of strings <= 100 items [ items <= 512 characters ] Webhook event types to subscribe to. If provided, replaces all existing subscriptions. Omitted leaves the subscriptions unchanged. Explicit null is rejected (422). |
| lock_version | integer <int64> Optimistic lock version: validated when provided (409 on mismatch); omitting it skips the concurrency check. Explicit null is rejected (422). |
ReplaceIntegrationSubscriptions
{- "subscriptions": [
- "device.updated",
- "user.updated"
], - "lock_version": 0
}UpdatedAlpineIntegrationEndpoint
{- "id": "00000000-0000-4000-8000-000000008001",
- "display_name": "Alpine maintenance integration",
- "signature_scheme": "HMAC_SHA256",
- "enabled": true,
- "retry": true,
- "subscriptions": [
- "device.updated",
- "user.updated"
], - "invalid_subscriptions": [ ],
- "created_at": "2026-08-20T08:40:00Z",
- "updated_at": "2026-08-20T09:40:00Z",
- "lock_version": 1
}Immediately delivers a test webhook to the specified endpoint to verify connectivity
| endpoint_id required | string <uuid> Endpoint id to send a test webhook to |
TestAlpineIntegrationEndpoint
{- "endpoint_id": "00000000-0000-4000-8000-000000008001"
}SuccessfulAlpineWebhookTest
{- "last_test_tried_at": "2026-08-20T09:50:00Z",
- "test_was_successful": true
}Returns comments on the given target, paginated. sort follows the v2 <mode>:<direction> convention: threaded:desc (default โ root comments newest-first; replies always oldest-first within each thread), threaded:asc, flat:desc, flat:asc. In threaded mode the page numbers refer to root comments and the response interleaves each root with its replies. Requires the comments read grant and read access to the target object.
| target_type required | string Example: target_type=object:equipment Family-prefixed identifier of the object the comments are attached to. Examples: |
| target_id required | string <uuid> Example: target_id=22222222-2222-3333-4444-555555555555 Id of the target object the comments are attached to. |
| page | integer >= 0 Default: 0 Page number (0-based). In threaded mode this refers to the root-comment page. |
| size | integer [ 1 .. 1000 ] Default: 20 Example: size=20 Number of root comments per page (threaded) or items per page (flat). Range 1..1000. The 1000 cap is intentionally higher than the platform default (100) because the comments list is the primary read path for moderation, audit-log, and AI-assistant scrapes โ workflows that need the full thread in one shot rather than paged. Frontends paginate at 20โ50; the high cap is for server-side and integration callers. |
| sort | string Default: "threaded:desc" Enum: "threaded:desc" "threaded:asc" "flat:desc" "flat:asc" Example: sort=threaded:desc Sort instruction in |
EquipmentCommentsPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000007501",
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "body_markdown": "Replacement filter ordered.",
- "author": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "created_at": "2026-03-03T10:45:00Z",
- "updated_at": "2026-03-03T10:45:00Z",
- "lock_version": 0,
- "is_edited": false,
- "is_moderated": false,
- "is_deleted": false,
- "is_deleted_by_moderator": false,
- "is_unread": false,
- "reactions": [ ],
- "mentions": [ ],
- "attachments": [ ]
}
], - "unread_count": 0,
- "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a comment on the given target. Create access follows the target adapter for the supplied target_type. Server-side dedup: a duplicate submission by the same author against the same target with the same body within the configured window (default 60s) returns the existing comment with HTTP 200 instead of inserting a duplicate.
Both the 201 (fresh insert) and 200 (dedup) responses include a Location: /api/v2/comments/{comment_id} header pointing at the persisted row, per RFC 7231.
| target_type required | string non-empty Family-prefixed identifier of the object the comment is attached to. Examples: |
| target_id required | string <uuid> Id of the target object the comment is attached to. |
| parent_comment_id | string <uuid> Id of the parent comment when posting a reply. Must exist and belong to the same target. Omit (or send |
| body_markdown required | string [ 1 .. 10000 ] characters Comment body in markdown. Server enforces the v2 allow-list (bold, italic, strikethrough (GFM |
| attachment_ids | Array of strings <uuid> [ items <uuid > ] Filestore file ids previously obtained from |
CreateEquipmentMaintenanceComment
{- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "body_markdown": "Replacement filter ordered."
}DeduplicatedFilterComment
{- "id": "00000000-0000-4000-8000-000000007501",
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "body_markdown": "Replacement filter ordered.",
- "author": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "created_at": "2026-03-03T10:45:00Z",
- "updated_at": "2026-03-03T10:45:00Z",
- "lock_version": 0,
- "is_edited": false,
- "is_moderated": false,
- "is_deleted": false,
- "is_deleted_by_moderator": false,
- "is_unread": false,
- "reactions": [ ],
- "mentions": [ ],
- "attachments": [ ]
}Clears the soft-delete tombstone on a comment. Always a moderator action; requires the comments:update grant. Returns 422 when the comment is not currently soft-deleted (comments.cannot-restore-not-deleted).
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the soft-deleted comment to restore. |
RestoredFilterComment
{- "id": "00000000-0000-4000-8000-000000007501",
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "body_markdown": "Replacement filter ordered.",
- "author": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "created_at": "2026-03-03T10:45:00Z",
- "updated_at": "2026-03-03T10:45:00Z",
- "lock_version": 0,
- "is_edited": false,
- "is_moderated": false,
- "is_deleted": false,
- "is_deleted_by_moderator": false,
- "is_unread": false,
- "reactions": [ ],
- "mentions": [ ],
- "attachments": [ ]
}Adds one of Tourfold's supported emoji reactions (๐ โค๏ธ ๐ ๐ ๐ฎ ๐ข ๐ ๐) by the calling user to the named comment. Requires comments:read and read access to the comment target. Idempotent: 201 on the first add, 200 on a duplicate add (no row inserted, no SSE / webhook emitted). Tombstoned comments reject reactions with comments.reaction-on-deleted-comment (422).
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment to react to. |
| emoji required | string Enum: "๐" "โค๏ธ" "๐" "๐" "๐ฎ" "๐ข" "๐" "๐" Emoji to react with. Supported values are |
AddThumbsUp
{- "emoji": "๐"
}ExistingThumbsUpReaction
{- "id": "00000000-0000-4000-8000-000000007501",
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "body_markdown": "Replacement filter ordered.",
- "author": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "created_at": "2026-03-03T10:45:00Z",
- "updated_at": "2026-03-03T10:45:00Z",
- "lock_version": 0,
- "is_edited": false,
- "is_moderated": false,
- "is_deleted": false,
- "is_deleted_by_moderator": false,
- "is_unread": false,
- "reactions": [
- {
- "emoji": "๐",
- "count": 1,
- "you_reacted": true,
- "your_reaction_id": "00000000-0000-4000-8000-000000007503"
}
], - "mentions": [ ],
- "attachments": [ ]
}Adds (or refreshes) the caller's unread override for the comment. Requires comments:read and read access to the comment target. The comment is then unread regardless of where the cursor sits. The cursor is not moved.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment to mark unread. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Removes the caller's per-comment unread override, if any. Requires comments:read and read access to the comment target. Does not move the cursor. Idempotent: a no-op success when no override exists.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment to clear the unread override on. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Sets the caller's read cursor on (target_type, target_id) to the named comment (inclusive). Requires comments:read and read access to the target. Monotonic โ naming an older comment is a no-op success returning the existing cursor. As a side effect, clears the caller's per-comment unread overrides at-or-before the new cursor.
| target_type required | string non-empty Family-prefixed identifier of the object the cursor lives on. Examples: |
| target_id required | string <uuid> Id of the target object the cursor lives on. |
| comment_id required | string <uuid> Id of the comment the cursor should advance to (inclusive). The comment must belong to the supplied |
MarkEquipmentCommentsRead
{- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "comment_id": "00000000-0000-4000-8000-000000007501"
}EquipmentCommentsReadCursor
{- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "last_seen_comment_id": "00000000-0000-4000-8000-000000007501",
- "last_seen_created_at": "2026-03-03T10:45:00Z"
}Validates MIME / size / storage allowance and returns a presigned form descriptor. The client then POSTs the bytes to upload_url as multipart/form-data, including every entry from upload_fields (preserving their original order) followed by the actual file payload under the file part. The returned attachment_id is referenced later in POST /api/v2/comments (or PATCH /api/v2/comments/{comment_id}) via the attachment_ids array. No core_comment_attachments row is created at this point โ files uploaded but never referenced are reaped asynchronously by the orphan-cleanup cron. Status is 200, not 201, because no addressable resource is exposed at a Location URL: the attachment_id is only meaningful once a subsequent comment create/edit references it. Requires the comments:create grant.
Not exposed via MCP โ agents can't fill in presigned forms; the comments_create and comments_update MCP tools strip any attachment_ids from incoming payloads.
| original_file_name required | string [ 0 .. 255 ] characters Original filename to persist on the filestore blob. Surfaced back in the attachment chip and download Content-Disposition; users see this exact string. |
| mime_type required | string non-empty MIME type of the file. Almost any MIME is accepted; the server enforces a denylist ( |
| size_bytes required | integer <int64> > 0 File size in bytes. Must be > 0 and โค |
CreateFilterPhotoUpload
{- "original_file_name": "rtu-17-filter.jpg",
- "mime_type": "image/jpeg",
- "size_bytes": 248320
}FilterPhotoUploadIntent
{- "attachment_id": "00000000-0000-4000-8000-000000007504",
- "upload_fields": {
- "key": "alpine/comments/rtu-17-filter.jpg",
- "policy": "example-not-a-real-policy"
}, - "expires_at": "2026-03-03T11:15:00Z"
}Returns one comment with its author and caller-scoped is_unread state. Used by the SSE-driven real-time wiring (the create event triggers a thin refetch to resolve the new author) and by deep-link openers that may target a comment which isn't on the currently visible list page. Requires the comments read grant and read access to the target object โ the same gating as GET /api/v2/comments.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment. |
EquipmentMaintenanceComment
{- "id": "00000000-0000-4000-8000-000000007501",
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "body_markdown": "Replacement filter ordered.",
- "author": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "created_at": "2026-03-03T10:45:00Z",
- "updated_at": "2026-03-03T10:45:00Z",
- "lock_version": 0,
- "is_edited": false,
- "is_moderated": false,
- "is_deleted": false,
- "is_deleted_by_moderator": false,
- "is_unread": false,
- "reactions": [ ],
- "mentions": [ ],
- "attachments": [ ]
}Marks the comment as deleted. Author can delete own; users with the comments:delete grant can delete any. Idempotent: if the comment is already soft-deleted, the call is a no-op success. Soft-deleted comments stay in the list as tombstones with is_deleted=true and an empty body_markdown โ the frontend renders a tombstone placeholder.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment to soft-delete. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Updates a comment's body. Author can edit own; users with the comments:update grant can edit any. Moderator edits (caller != author) require a non-blank edit_reason โ the server returns 422 (comments.moderation-reason-required) when missing. On success an audit row is appended to core_comment_edits in the same transaction; the response carries the updated comment with is_edited (and, for moderator edits, is_moderated) set to true.
Concurrency model: optional optimistic locking. Include the lock_version you last read to guard the edit โ if it no longer matches the stored version the API returns 409 Conflict (resource-conflict); omit it (or send null) for last-write-wins, where the request that commits second overwrites the first. Either way every edit is appended to core_comment_edits as a separate audit row, so clients that need to reconcile can consult GET /api/v2/comments/{comment_id}/edits after their write.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment to edit. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check |
| body_markdown | string New comment body in markdown. Omit to leave unchanged. Explicit |
| edit_reason | string or null Reason for the edit. Required (non-blank) when the caller is moderating another user's comment under the |
| attachment_ids | Array of strings or null <uuid> [ items <uuid > ] Replacement attachment list. Omit this field to leave the comment's attachments untouched โ this is the typical case when the caller only wants to edit |
UpdateFilterComment
{- "body_markdown": "Replacement filter ordered for Friday.",
- "lock_version": 0
}UpdatedFilterComment
{- "id": "00000000-0000-4000-8000-000000007501",
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "body_markdown": "Replacement filter ordered for Friday.",
- "author": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "created_at": "2026-03-03T10:45:00Z",
- "updated_at": "2026-03-03T11:00:00Z",
- "lock_version": 1,
- "last_edited_at": "2026-03-03T11:00:00Z",
- "is_edited": true,
- "is_moderated": false,
- "is_deleted": false,
- "is_deleted_by_moderator": false,
- "is_unread": false,
- "reactions": [ ],
- "mentions": [ ],
- "attachments": [ ]
}Computes which page of GET /api/v2/comments contains [id] under the given sort + size. Used by deep-link openers (frontend ?commentId=โฆ) to jump straight to the right page without paginating one click at a time. In threaded mode the returned page is the page of root comments; if the target is a reply, its row appears under its root on that page. Requires the comments read grant and read access to the target object โ the same gating as the list endpoint.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment to locate. |
| sort | string Default: "threaded:desc" Enum: "threaded:desc" "threaded:asc" "flat:desc" "flat:asc" Example: sort=threaded:desc Same |
| size | integer [ 1 .. 1000 ] Default: 20 Example: size=20 Page size used for the index calculation. Must match the |
EquipmentCommentPageInfo
{- "comment_id": "00000000-0000-4000-8000-000000007501",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "mode": "threaded",
- "page": 0,
- "total_pages": 1
}Returns the ordered audit trail for a single comment, newest-first. Each entry includes the editor reference, the body as it stood before the edit, the (moderator) edit_reason, the per-edit attachment-name diff (attachments_added_names / attachments_removed_names), and is_moderation (derived from editor.id != author.id). Requires the comments:update grant.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment. |
FilterCommentEditHistory
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000007502",
- "edited_at": "2026-03-03T11:00:00Z",
- "editor": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "previous_body_markdown": "Replacement filter ordered.",
- "is_moderation": false,
- "attachments_added_names": [ ],
- "attachments_removed_names": [ ]
}
]
}Returns the mention target's display name and deletion state. Requires comments:read, comments:create, or comments:update. For user mentions, email is omitted and roles remains an empty array ([]) for compatibility.
Deleted targets return 200 with is_deleted=true: a deleted user keeps their display_name, while an anonymized user has an empty display_name (and email omitted, roles: []). Clients must check is_deleted before treating the response as a live target. Unknown ids (e.g. cross-tenant) return 404 comments/mention-target-not-found.
| target_type required | string Value: "user" Example: user Mention-type discriminator. |
| target_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Target id. |
AlpineUserMentionDetail
{- "type": "user",
- "id": "00000000-0000-4000-8000-000000000102",
- "display_name": "Jonas Leitner",
- "is_deleted": false,
- "roles": [ ]
}Returns up to limit mention targets matching search for the requested target_type. Ranked: prefix-matches first (alpha-sorted within), substring matches second (alpha-sorted within). Empty search returns the top-N targets alpha-sorted. Requires the comments:create grant โ read-only viewers never need the picker. Tenant scope is enforced by the schema interceptor.
| search | string Example: search=ali Free-text query. Matches against first / last name and email for user mentions. Empty / missing โ top-N alpha-sorted. |
| target_type | string Example: target_type=user Mention-type discriminator to search. Currently only |
| limit | integer [ 1 .. 50 ] Default: 10 Example: limit=10 Maximum number of suggestions to return. Range 1..50. |
AlpineUserMentionSuggestions
{- "items": [
- {
- "type": "user",
- "id": "00000000-0000-4000-8000-000000000102",
- "display_name": "Jonas Leitner",
- "secondary_text": "jonas.leitner@example.invalid"
}
]
}Returns total and caller-scoped unread counts for every requested target the caller may read, preserving request order. Readable targets with no comments receive explicit zero counts. Missing and unreadable targets are omitted without revealing whether they exist. Tombstones are excluded from both counts.
| target_type required | string Example: target_type=object:equipment Family-prefixed identifier of the object the comments are attached to. Examples: |
| target_ids required | Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ] Example: target_ids=22222222-2222-3333-4444-555555555555 Target ids to count for. Supply 1 to 100 UUIDs by repeating the plural |
EquipmentCommentCounts
{- "items": [
- {
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "count": 1,
- "unread_count": 0
}
]
}Presigned URLs returned on the comment list endpoint expire after comments.attachments.download-url-ttl-seconds (default 5 min). This endpoint refreshes them for a single attachment โ used by the preview modal when the user opens a chip / inline image long after the comment was first rendered.
Authorisation gate: the caller must be authenticated in the tenant and the parent comment must exist and be live (not soft-deleted), with read access to its target.
Set download=true to sign the original URL for an attachment download with its stored filename. Omitted/false preserves safe inline handling; thumbnail URLs always retain that default.
Error contract:
comments/attachment-not-found when no attachment row matches the id, when its parent comment was hard-deleted (FK cascade drops the row), or when the parent comment has been soft-deleted.comments/target-not-found when the parent comment target is unavailable.filestore/file-not-found when the original rendition is unavailable on an active file.comments/attachment-blob-gone when the row exists but the underlying filestore blob has been hard-deleted (target cascade, manual purge, orphan-cleanup gap). The client should NOT retry; the list endpoint still surfaces the row with is_deleted=true so the comment body keeps its placeholder chip.| attachment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Comment attachment id. |
| download | boolean Default: false Force attachment download of the original; defaults to safe inline handling. |
FilterPhotoDownloadUrls
{- "expires_at": "2026-03-03T11:20:00Z"
}Removes the calling user's reaction row addressed by the opaque {reaction_id} (read from reactions[*].your_reaction_id on a recent CommentResponse). Requires comments:read and read access to the comment target. Returns the updated comment. 404 comments/reaction-not-found when the id does not exist OR belongs to a different user โ both cases return the same problem so the surface doesn't leak the existence of other users' reaction rows. The path id (rather than the emoji) avoids the fragile URL-encoding of skin-tone modifiers, ZWJ sequences, and similar. Removal uses the stored value without reparsing it so historical or manually repaired rows remain cleanable.
| comment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Id of the comment to un-react from. Used only for routing โ the reaction id alone is sufficient to identify the row to remove. |
| reaction_id required | string <uuid> Example: 33333333-aaaa-bbbb-cccc-dddddddddddd Opaque id of the caller's reaction row. Read from |
CommentWithoutReaction
{- "id": "00000000-0000-4000-8000-000000007501",
- "target_type": "object:equipment",
- "target_id": "6f3d2a10-0000-4000-8000-000000000101",
- "root_comment_id": "00000000-0000-4000-8000-000000007501",
- "body_markdown": "Replacement filter ordered.",
- "author": {
- "id": "00000000-0000-4000-8000-000000001002",
- "first_name": "Jonas",
- "last_name": "Leitner",
- "is_deleted": false
}, - "created_at": "2026-03-03T10:45:00Z",
- "updated_at": "2026-03-03T10:45:00Z",
- "lock_version": 0,
- "is_edited": false,
- "is_moderated": false,
- "is_deleted": false,
- "is_deleted_by_moderator": false,
- "is_unread": false,
- "reactions": [ ],
- "mentions": [ ],
- "attachments": [ ]
}Marks the filestore blob as deleted so storage is reclaimed immediately when the user changes their mind about an attachment in the composer (clicks the pill โ before posting the comment). Without this endpoint, abandoned uploads sit on filestore for up to comments.attachments.orphan-retention-hours (default 24) before the nightly orphan-cleanup task sweeps them.
Idempotent. Repeated DELETEs return 204; the second call is a no-op on an already-deleted file.
Scope. Only deletes files whose source_key is COMMENT_ATTACHMENTS AND that are NOT yet linked to a posted comment. Once a file is part of core_comment_attachments the proper removal path is the comment-delete endpoint (which cascades blob removal via the comment hard-delete hook).
Authorisation gate. Requires the comments:create grant โ same as the upload-intent endpoint. There is no per-uploader check: filestore does not track uploader identity and UUID-unguessability + schema-per-tenant isolation are the gates against cross-user / cross-tenant abuse, matching the orphan-cleanup task's posture (which also treats every unreferenced file the same way regardless of who uploaded it).
Not exposed via MCP โ abandoned-upload cleanup is a UI-driven affordance and the agent surface doesn't have a use case for it.
| attachment_id required | string <uuid> Example: 11111111-aaaa-bbbb-cccc-dddddddddddd Comment attachment id of the abandoned upload. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Self-service on the Device proven by this request, never a user-wide most-recent Device
Requires a current human login, secondary Device proof and devices:vehicles:assign-self. Ends the exact observed association, including an explicitly released fixed association. A newer episode conflicts. Keeps human login, Tour assignments and retained location; no replacement source is selected. Plugin work guards apply.
| X-Device-Authorization required | string Required Device bearer token alongside the human token. Missing: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
| expected_vehicle_association_id required | string <uuid> Exact episode observed when this action began; never replace it on retry. |
observed
{- "expected_vehicle_association_id": "00000000-0000-4000-8000-000000000108"
}context
{- "device_id": "00000000-0000-4000-8000-000000000101"
}Proves this request Device with the secondary header. A missing or different current human login is concealed as 404.
| X-Device-Authorization required | string Required Device bearer token alongside the human token. Missing: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
context
{- "id": "00000000-0000-4000-8000-000000000109",
- "device_id": "00000000-0000-4000-8000-000000000101",
- "user_id": "00000000-0000-4000-8000-000000000102",
- "started_at": "2023-02-14T10:00:00Z"
}A human bearer token and secondary Device bearer token are required. Returns a fresh episode; capture its ID for logout. Registration is not a heartbeat and has no request replay key.
| X-Device-Authorization required | string Required Device bearer token alongside the human token. Missing: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
context
{- "id": "00000000-0000-4000-8000-000000000109",
- "device_id": "00000000-0000-4000-8000-000000000101",
- "user_id": "00000000-0000-4000-8000-000000000102",
- "started_at": "2023-02-14T10:00:00Z"
}Ends only the supplied login episode. A newer episode conflicts, including another login by the same person. Retains Device credentials, Vehicle assignment and other human sessions.
| X-Device-Authorization required | string Required Device bearer token alongside the human token. Missing: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
| expected_user_association_id required | string <uuid> Exact episode observed when this action began; never replace it on retry. |
observed
{- "expected_user_association_id": "00000000-0000-4000-8000-000000000109"
}context
{- "device_id": "00000000-0000-4000-8000-000000000101"
}Requires the Device as primary bearer actor. Both expected IDs are optional and nullable (omitted or null expects no active episode). Cleans up the observed context atomically; a newer episode conflicts. Retains enrollment and Tour assignments. Clear native Device credentials only after acknowledgment. Retry with the same expected IDs after an uncertain response.
| expected_vehicle_association_id | string or null <uuid> Observed Vehicle episode, or omitted/null when none exists. |
| expected_user_association_id | string or null <uuid> Observed human login episode, or omitted/null when none exists. |
observed
{- "expected_vehicle_association_id": null,
- "expected_user_association_id": null
}context
{- "device_id": "00000000-0000-4000-8000-000000000101"
}Accepts human plus secondary Device proof, or the Device as primary actor for its own logout recovery. Returns own episode identity even without Vehicle read permission; never exposes another user profile. A foreign human login is concealed as 404. Empty context omits vehicle_association.
| X-Device-Authorization | string Required with a human primary bearer; omitted with a Device primary bearer. Missing: device_proof_missing; malformed or unusable: device_proof_invalid; wrong tenant: tenant_scope; non-Device principal: wrong_actor_type. |
context
{- "device_id": "00000000-0000-4000-8000-000000000101"
}Fetches one object by slug or id.
| definition_ref required | string Object slug or UUID id |
| If-None-Match | string Optional ETag for conditional revalidation |
Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Declaratively replaces an object's metadata and attribute set (optimistic-locked). An attribute sent with its existing id and a changed slug is renamed (the id anchors it); an id-less attribute with an existing slug keeps its identity, otherwise it is added; absent owned attributes are removed. Managed reverse relationship attributes materialized from another object are outside this replacement set: omit them here and update the declaring relationship on its owning object.
| definition_ref required | string Object slug or UUID id |
| natural_id_key | string or null^[A-Z][A-Z0-9]{0,15}$ Optional natural ID prefix, unique across definitions when set. Null means numeric-only string IDs. Omission preserves the prefix on PATCH and means no prefix on creation or replacement. Use 1โ16 uppercase letters or digits, starting with a letter. Changing it changes displayed IDs without changing record identity or counters. |
| slug required | string <= 63 characters ^[a-z][a-z0-9_]*$ Object slug. The plugin_ prefix is reserved for plugin-managed definitions; self and this are reserved words. |
required | object Entity noun per canonical language tag |
| display_template | string Display template with {{slug}} placeholders |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon key from the client icon catalog, for example |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Palette color of the definition icon. Omission or null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Attribute slugs shown, in order, under the record name and the clicked location in a map popup, for example |
required | Array of any (AttributeInput) The object's full attribute set |
| lock_version | integer <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
rename, add and remove in one declaration
{- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "lock_version": 3,
- "attributes": [
- {
- "id": "0b9455a3-6ea9-4e2e-8a1f-1f4b0a4a5c1d",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}
}, - {
- "slug": "operational",
- "type": "boolean",
- "name": {
- "en": "Operational"
}
}
]
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Deletes an object (by slug or id) including its record table. An object targeted by a relationship attribute owned by another object cannot be deleted until that attribute is removed.
| definition_ref required | string Object slug or UUID id |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Merge metadata without changing attributes. Names merge by language and noun form; null clears display_template, icon, color or map_marker_fields. Managed schemas are locked except for icon, color, map_marker_fields and, where records are numbered per definition, natural_id_key.
| definition_ref required | string Object definition UUID or slug |
| natural_id_key | string or null^[A-Z][A-Z0-9]{0,15}$ Optional natural ID prefix, unique across definitions when set. Null means numeric-only string IDs. Omission preserves the prefix on PATCH and means no prefix on creation or replacement. Use 1โ16 uppercase letters or digits, starting with a letter. Changing it changes displayed IDs without changing record identity or counters. |
| slug | string <= 63 characters Definition slug. Null is rejected. |
object Merge by language and noun form. Null language/form removes it. At least one localized name must remain; root null is rejected. | |
| display_template | string or null [ 1 .. 2000 ] characters Display template; null restores the default label. Blank strings are rejected. |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon catalog key. Omission preserves it; null restores the default icon. |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Icon background palette color. Omission preserves it; null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Ordered popup field selection. Omission preserves it; null clears it to an empty list; an array replaces it. Lists and structured JSON fields are unsupported. |
| lock_version | integer or null <int64> >= 0 Optional version precondition; stale versions return 409. |
clearTemplate
{- "display_template": null,
- "lock_version": 0
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Replaces the display order of all attributes atomically, the system attributes (id, created_at, updated_at, lock_version), natural_id and managed reverse relationships included. List every slug of the object's attributes exactly once; the response returns attributes in this order, which also drives record forms and the default list columns. Only the order changes. Until an order is saved, id comes first and created_at, updated_at and lock_version come last. Later attribute additions are appended.
| definition_ref required | string Object slug or UUID id. |
| attribute_slugs required | Array of strings non-empty Slug of every attribute of the object, each exactly once, in display order (first = topmost). This is the set of slugs in the object's |
| lock_version | integer <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
TimestampsAfterName
{- "attribute_slugs": [
- "name",
- "created_at",
- "updated_at",
- "asset_tag",
- "category",
- "id",
- "natural_id",
- "lock_version"
], - "lock_version": 3
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Lists the tenant's objects, paged in stable ascending slug order.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
| If-None-Match | string Optional ETag for conditional revalidation |
EquipmentPage
{- "items": [
- {
- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates an object with its full attribute set.
| natural_id_key | string or null^[A-Z][A-Z0-9]{0,15}$ Optional natural ID prefix, unique across definitions when set. Null means numeric-only string IDs. Omission preserves the prefix on PATCH and means no prefix on creation or replacement. Use 1โ16 uppercase letters or digits, starting with a letter. Changing it changes displayed IDs without changing record identity or counters. |
| slug required | string <= 63 characters ^[a-z][a-z0-9_]*$ Object slug. The plugin_ prefix is reserved for plugin-managed definitions; self and this are reserved words. |
required | object Entity noun per language tag, e.g. {"en": {"singular": "Asset", "plural": "Assets"}} |
| display_template | string Display template with {{slug}} placeholders |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon key from the client icon catalog, for example |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Palette color of the definition icon. Omission or null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Attribute slugs shown, in order, under the record name and the clicked location in a map popup, for example |
required | Array of any (AttributeInput) The object's typed attributes |
maintenance request
{- "slug": "maintenance_request",
- "name": {
- "en": {
- "singular": "Maintenance Request",
- "plural": "Maintenance Requests"
}
}, - "display_template": "{{title}}",
- "attributes": [
- {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "config": {
- "is_required": true
}
}
]
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Adds one attribute to an object (incremental). Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| id | string <uuid> Existing attribute id (omit on create; send to update/rename) |
| slug required | string <= 200 characters ^[a-z][a-z0-9_]*$ Attribute slug; self, this and platform record fields are reserved. |
| type required | string Attribute type selecting this configuration. |
object Attribute label per language tag, e.g. {"en": "Purchase price"} | |
| description | string Optional attribute description |
object (TextAttributeConfigInput) Configuration for text attributes. | |
| lock_version | integer <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
AddSerialNumber
{- "slug": "serial_number",
- "type": "text",
- "name": {
- "en": "Serial number"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "lock_version": 3
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Adds one state to a state attribute. Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Attribute slug or stable id. |
| value required | string Mutable state value/code |
| title required | string Display title for the state |
| color required | string Color code used to render the state |
| lock_version | integer <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
AddBlocked
{- "value": "blocked",
- "title": "Blocked",
- "color": "#FF0000"
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Adds one option to a select attribute. Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Attribute slug or stable id. |
| value required | string Mutable option value/code |
| title required | string Display title for the option |
| lock_version | integer <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
AddLeased
{- "value": "leased",
- "title": "Leased"
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Removes one owned attribute (by slug or id). Managed reverse relationships must be deleted from the declaring attribute on their owning object. Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Target attribute slug or id |
Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Updates/renames one attribute (by slug or id). Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Target attribute slug or id |
| id | string or null <uuid> Optional identity assertion; must match the routed attribute. |
| type | string or null Enum: "text" "license_plate" "vin" "number" "date" "date_time" "boolean" "select" "state" "capacity" "measure" "currency" "rating" "email" "phone" "tags" "required_skills" "provided_skills" "relationship" "location" "raw_json" "rich_text" "full_name" "links" null Optional type assertion; cannot change the stored type. |
| slug | string <= 200 characters ^[a-z][a-z0-9_]*$ New slug. Omission preserves it; null cannot clear it. |
object Merge localized labels. Null at a language key removes that translation. | |
| description | string or null Null clears the description; blank text is rejected. |
object or null Merge type-specific configuration keys with the stored configuration. Null clears an optional setting; null config resets optional configuration. Required settings, immutable uniqueness, unknown keys and keys belonging to another type are validated after merging. | |
Array of objects (SelectOptionInput) Select only: replaces choices; [] clears them. Existing choice IDs preserve stored values. | |
Array of objects (StateInput) State only: replaces states; [] clears them. Existing state IDs preserve stored values. | |
| lock_version | integer or null <int64> >= 0 Optional definition version precondition. |
RenameToMinStock
{- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "min_stock",
- "type": "number",
- "name": {
- "en": "Min stock"
}, - "config": {
- "is_required": false
}
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Removes one state (by value or id). Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Attribute slug or stable id. |
| state_ref required | string Target state value or id |
Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Updates one state's mutable value, title, and/or color (found by value or id). Its stable id and record references stay unchanged. Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Attribute slug or stable id. |
| state_ref required | string Target state value or id |
| value | string New mutable state value/code. Omitted leaves the value unchanged. Explicit null is rejected (422) โ a state value cannot be cleared. |
| title | string New display title. Omitted leaves the title unchanged. Explicit null is rejected (422) โ a state title cannot be cleared. |
| color | string New color code. Omitted leaves the color unchanged. Explicit null is rejected (422) โ a state color cannot be cleared. |
| lock_version | integer or null <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
RecolorOnly
{- "color": "#F59E0B"
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Removes one select option (by value or id). Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Attribute slug or stable id. |
| option_ref required | string Target option value or id |
Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Updates one select option's mutable value and/or title (found by value or id). Its stable id and record references stay unchanged. Returns the updated object.
| definition_ref required | string Object slug or UUID id. |
| attribute_ref required | string Attribute slug or stable id. |
| option_ref required | string Target option value or id |
| value | string New mutable option value/code. Omitted leaves the value unchanged. Explicit null is rejected (422) โ an option value cannot be cleared. |
| title | string New display title. Omitted leaves the title unchanged. Explicit null is rejected (422) โ an option title cannot be cleared. |
| lock_version | integer or null <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
RelabelOnly
{- "title": "Scheduled"
}Equipment
{- "id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
- "slug": "equipment",
- "name": {
- "en": {
- "singular": "Equipment",
- "plural": "Equipment"
}
}, - "display_template": "{{name}} ({{asset_tag}})",
- "icon": "toolbox",
- "color": "orange",
- "map_marker_fields": [
- "asset_tag",
- "category"
], - "managed_by": "tenant",
- "schema_policy": "editable",
- "is_readonly": false,
- "attributes": [
- {
- "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "slug": "name",
- "type": "text",
- "name": {
- "en": "Name"
}, - "config": {
- "is_required": true,
- "is_unique": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
- "slug": "asset_tag",
- "type": "text",
- "name": {
- "en": "Asset tag"
}, - "config": {
- "is_required": true,
- "is_unique": true
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
]
}, - {
- "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
- "slug": "category",
- "type": "select",
- "name": {
- "en": "Category"
}, - "config": {
- "is_required": false,
- "is_unique": false,
- "is_multiselect": false
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "is_null"
], - "options": [
- {
- "id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
- "value": "hvac",
- "title": "HVAC"
}, - {
- "id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
- "value": "elevator",
- "title": "Elevator"
}
]
}
], - "created_at": "2026-07-01T09:30:00Z",
- "updated_at": "2026-07-02T14:00:00Z",
- "lock_version": 3,
- "resource_type": "object",
- "is_relationship_target": true
}Requires tour read access. Every assigned Task occurs once, either directly in the root sequence or inside a planned stop.
| tour_id required | string <uuid> Parent Tour UUID |
OrderedItems
{- "items": [
- {
- "type": "task",
- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab"
}, - {
- "type": "stop",
- "stop_id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "task_ids": [
- "9bd78c05-ad21-4da2-8f7a-a15ab5c25dd5"
]
}
], - "lock_version": 2
}Requires tours:update or own ad-hoc planning access. Changes root order, grouping and child order atomically without editing Tasks. Supply every assigned Task and standalone stop exactly once. Empty automatic stops disappear. An empty list is valid only when no assigned Tasks or standalone stops remain.
| tour_id required | string <uuid> Parent Tour UUID |
required | Array of any (TourOrderItem) [ 0 .. 10000 ] items |
| lock_version | integer or null <int64> >= 0 Parent Tour version; omitted or null skips the precondition. |
Reorder
{- "items": [
- {
- "type": "task",
- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab"
}, - {
- "type": "stop",
- "stop_id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "task_ids": [
- "9bd78c05-ad21-4da2-8f7a-a15ab5c25dd5"
]
}
], - "lock_version": 2
}OrderedItems
{- "items": [
- {
- "type": "task",
- "task_id": "07b8775e-49d7-4980-adfe-1423a87765ab"
}, - {
- "type": "stop",
- "stop_id": "a1b937f0-cdea-48aa-b8b7-c24ca6a6de26",
- "task_ids": [
- "9bd78c05-ad21-4da2-8f7a-a15ab5c25dd5"
]
}
], - "lock_version": 2
}Retrieve a paginated list of webhook delivery failures for the current tenant.
A row represents the latest recorded failed attempt for one webhook message. The same row is updated when another retry fails, while the first and latest failure timestamps remain available. This endpoint is not a full delivery or per-attempt audit ledger: successful attempts and deliveries skipped before an HTTP request are not recorded. A successful retry after an earlier failure does not add a success record, so absence does not prove success and presence alone does not prove the message ultimately failed.
Use the filters to narrow down results by time range, endpoint, or event type.
Requires any of 'webhooks:read', 'webhooks:create', or 'webhooks:update' grant.
| page | integer >= 0 Default: 0 Page number (0-based). First page is 0. |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page. Maximum allowed is 100. |
| failed_from | string <date-time> Example: failed_from=2024-01-01T00:00:00Z Return failures whose first failed attempt occurred at or after this RFC 3339 timestamp (inclusive). |
| failed_to | string <date-time> Example: failed_to=2025-01-01T00:00:00Z Return failures whose first failed attempt occurred before this RFC 3339 timestamp (exclusive). |
| endpoint_id | string <uuid> Example: endpoint_id=019bb29d-2458-722e-b21b-679e632ca96b Filter by specific webhook endpoint ID. |
| event_type | string Example: event_type=area.created Filter by event type. |
| sort | string Default: "first_attempt_failed_at:desc" Example: sort=first_attempt_failed_at:desc Single sorting criterion in |
DeliveryFailuresResponse
{- "items": [
- {
- "id": "f8c1b4b5-ffe8-4d1c-8f0a-8c55e7b9c6d1",
- "message_id": "a1b2c3d4-e5f6-4a1b-8c9d-123456789abc",
- "endpoint_id": "019bb29d-2458-722e-b21b-679e632ca96b",
- "event_type": "area.created",
- "attempt": 3,
- "retries_remaining": 4,
- "will_retry": true,
- "retry_state": "RETRYING",
- "http_status_code": 500,
- "error_message": "HTTP 500: Internal Server Error",
- "first_attempt_failed_at": "2024-11-10T10:00:00Z",
- "latest_retry_attempt_failed_at": "2024-11-10T10:30:00Z"
}, - {
- "id": "a83f3f6c-6d3b-4f3a-89d7-1d3c9d0f1c2b",
- "message_id": "b2c3d4e5-f6a7-4b1c-9d0e-234567890bcd",
- "endpoint_id": "019bb29d-2458-722e-b21b-679e632ca96b",
- "event_type": "area.updated",
- "attempt": 10,
- "retries_remaining": 0,
- "will_retry": false,
- "retry_state": "EXHAUSTED",
- "error_message": "Connection timed out",
- "first_attempt_failed_at": "2024-11-09T12:00:00Z",
- "latest_retry_attempt_failed_at": "2024-11-09T15:45:00Z"
}
], - "page": {
- "size": 20,
- "total_elements": 2,
- "total_pages": 1,
- "number": 0
}
}Pulls the tenant's live subscription status from Stripe and updates the stored billing standing, then returns the refreshed decision. Acts as a fallback when a Stripe webhook has not yet arrived โ e.g. a user who just updated their payment method on the billing-locked screen and wants to unlock immediately. Reachable while the tenant is billing-locked.
ActiveAlpineBilling
{- "allowed": true,
- "status": "ACTIVE"
}Returns a one-time URL the client should redirect the user to so they can manage their payment method in Stripe's hosted Customer Portal. The tenant must already have a Stripe customer (paid plan).
| return_url required | string [ 0 .. 2048 ] characters Absolute URL the customer is redirected to after closing the Stripe Customer Portal. The origin must match the tenant's primary domain or one of its configured custom domains. |
CreateAlpineBillingPortalSession
{
}AlpineBillingPortalSession
Returns a summary (brand, last4, expiry) of the default payment method attached to the tenant's Stripe customer. The has_payment_method flag is false when no card is on file yet.
AlpinePaymentMethod
{- "has_payment_method": true,
- "brand": "visa",
- "last4": "4242",
- "exp_month": 12,
- "exp_year": 2028
}Creates a presigned upload form for a new tenant logo.
| original_file_name required | string non-empty Original filename |
| mime_type required | string non-empty ^[iI][mM][aA][gG][eE]/([pP][nN][gG]|[jJ][pP][... MIME type (image/png, image/jpeg or image/jpg, case-insensitive) |
CreateTenantLogoUpload
{- "original_file_name": "alpine-facility-services-logo.png",
- "mime_type": "image/png"
}AlpineTenantLogoUpload
{- "file_id": "00000000-0000-4000-8000-000000000701",
- "upload_fields": {
- "key": "alpine/tenant-logo.svg",
- "policy": "example-not-a-real-policy"
}, - "expires_at_utc": "2026-08-20T10:15:00Z"
}Creates a presigned upload form for a new tenant favicon.
| original_file_name required | string non-empty Original filename |
| mime_type required | string non-empty ^[iI][mM][aA][gG][eE]/([pP][nN][gG]|[jJ][pP][... MIME type (image/png, image/jpeg or image/jpg, case-insensitive) |
CreateTenantFaviconUpload
{- "original_file_name": "alpine-favicon.png",
- "mime_type": "image/png"
}AlpineTenantFaviconUpload
{- "file_id": "00000000-0000-4000-8000-000000000702",
- "upload_fields": {
- "key": "alpine/favicon.png",
- "policy": "example-not-a-real-policy"
}, - "expires_at_utc": "2026-08-20T10:15:00Z"
}JSON Merge Patch (RFC 7386). Omitted fields remain unchanged. help_url is the only clearable field: send an explicit null to fall back to the platform default.
| name | string <= 255 characters Tenant name. Omitted leaves the value unchanged; explicit null is rejected (422). |
| language | string <= 10 characters Tenant content language tag. Legacy locale-style values such as en-US are accepted and normalized. Omitted leaves the value unchanged; explicit null is rejected (422). |
| region | string <= 2 characters Tenant region as ISO 3166-1 alpha-2 country code. Omitted leaves the value unchanged; explicit null is rejected (422). |
| timezone | string <= 50 characters Tenant timezone as IANA timezone identifier. Omitted leaves the value unchanged; explicit null is rejected (422). |
| help_url | string or null <= 2048 characters Absolute http(s) URL opened by the Help entry in the workspace header menu. Omitted leaves the value unchanged; explicit null clears it so clients use the platform default. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check. |
UpdateName
{- "name": "Alpine Facility Services GmbH",
- "lock_version": 0
}UpdatedAlpineTenant
{- "name": "Alpine Facility Services GmbH",
- "language": "de",
- "region": "AT",
- "timezone": "Europe/Vienna",
- "lock_version": 0
}Removes the current tenant logo. Repeating the request is safe.
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Returns upload and application status for a tenant logo upload intent.
| file_id required | string <uuid> UUID of the uploaded file. |
UploadedAlpineTenantLogo
{- "file_id": "00000000-0000-4000-8000-000000000701",
- "status": "UPLOADED",
- "applied": true,
}Removes the current tenant favicon. Repeating the request is safe.
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Returns upload and application status for a tenant favicon upload intent.
| file_id required | string <uuid> UUID of the uploaded file. |
UploadedAlpineTenantFavicon
{- "file_id": "00000000-0000-4000-8000-000000000702",
- "status": "UPLOADED",
- "applied": true,
}Returns the current AI assistant operating mode for this tenant.
ReadOnlyAssistantSettings
{- "mode": "READ_ONLY",
- "enabled": true,
- "tool_mode": "READ_ONLY",
- "tenant_id": "00000000-0000-4000-8000-000000000001"
}Updates the AI assistant mode. OFF disables the assistant, READ_ONLY enables read-only tools, and READ_WRITE enables read and write-capable tools.
| mode | string Enum: "OFF" "READ_ONLY" "READ_WRITE" New assistant mode. OFF disables the assistant, READ_ONLY enables read-only tool access, READ_WRITE enables read and write-capable tool access. Omit to leave unchanged; explicit null is rejected (422). |
EnableReadOnlyAssistant
{- "mode": "READ_ONLY"
}UpdatedReadOnlyAssistantSettings
{- "mode": "READ_ONLY",
- "enabled": true,
- "tool_mode": "READ_ONLY",
- "tenant_id": "00000000-0000-4000-8000-000000000001"
}Returns a paginated list of devices with their latest telemetry snapshot.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Number of items per page (max 100). |
| sort | Array of strings Example: sort=natural_id:asc Repeated sorting criteria in |
| search | string Case-insensitive search in model, identity, phone number, or description; also matches an exact displayed natural ID such as |
| natural_id | string Example: natural_id=MOB-12 Exact natural ID: the number shared across kinds ( |
| model | string Filter by device model (case-insensitive substring match). |
| kind | string Enum: "TOURFOLD_APP" "THIRD_PARTY_OSMAND" "TRACKING_DEVICE" Filter by device kind. |
| has_location | boolean Filter to devices with or without a latest location. |
| updated_from | string <date-time> Filter to devices updated at or after this timestamp. |
| updated_to | string <date-time> Filter to devices updated before this timestamp. |
| include | Array of strings Items Value: "current_state" Example: include=current_state Optional related resources to embed. Supported: |
| min_lat | number <double> [ -90 .. 90 ] Latest-location bounding box: minimum latitude. All four bbox corners must be supplied together. |
| min_lon | number <double> [ -180 .. 180 ] Latest-location bounding box: minimum longitude. All four bbox corners must be supplied together. |
| max_lat | number <double> [ -90 .. 90 ] Latest-location bounding box: maximum latitude. All four bbox corners must be supplied together. |
| max_lon | number <double> [ -180 .. 180 ] Latest-location bounding box: maximum longitude. All four bbox corners must be supplied together. |
| unassociated_only | boolean Default: false When true, only return devices without an active vehicle association. |
TechnicianDevicesPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000004001",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T08:00:00Z",
- "lock_version": 0,
- "natural_id": "MOB-17",
- "kind": "TOURFOLD_APP",
- "effective_app_location_tracking_policy": "continuous",
- "app_location_tracking_policy_source": "workspace",
- "device_model": "Pixel 9",
- "device_identity_id": "jonas-pixel-9",
- "provisioning_state": "PROVISIONED",
- "phone_number": "+436641234567",
- "platform": "ANDROID",
- "logout_device_with_user": false,
- "self_enrolled": false,
- "enrolled": true,
- "description": "Jonas Leitner's service device"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a device. Provisioning state is system-managed and is not accepted in this request.
| description | string [ 0 .. 2048 ] characters |
| device_identity_id | string [ 0 .. 255 ] characters Required for tracking hardware; otherwise may be bound during setup. |
| device_model | string [ 0 .. 128 ] characters |
| kind required | string |
| logout_device_with_user | boolean When true, logging the human out also ends the device (telemetry) session. Defaults to false. |
| phone_number | string [ 0 .. 32 ] characters International phone number with explicit country code; normalized to E.164. |
| platform required | string Enum: "IOS" "ANDROID" Supported Tourfold app platforms |
| app_location_tracking_policy_override | string or null Enum: "disabled" "during_work" "continuous" null App GPS policy override. Omission or null inherits the workspace policy. |
CreateTechnicianDevice
{- "kind": "TOURFOLD_APP",
- "device_model": "Pixel 9",
- "device_identity_id": "jonas-pixel-9",
- "phone_number": "+43 664 123 45 67",
- "platform": "ANDROID",
- "logout_device_with_user": false,
- "description": "Jonas Leitner's service device"
}CreatedTechnicianDevice
{- "id": "00000000-0000-4000-8000-000000004001",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T08:00:00Z",
- "lock_version": 0,
- "natural_id": "MOB-17",
- "kind": "TOURFOLD_APP",
- "effective_app_location_tracking_policy": "continuous",
- "app_location_tracking_policy_source": "workspace",
- "device_model": "Pixel 9",
- "device_identity_id": "jonas-pixel-9",
- "provisioning_state": "PROVISIONED",
- "phone_number": "+436641234567",
- "platform": "ANDROID",
- "logout_device_with_user": false,
- "self_enrolled": false,
- "enrolled": true,
- "description": "Jonas Leitner's service device"
}Generates a setup payload the client renders as a QR code. The payload is routed by device kind: a rotating Tourfold App enrollment link, the idempotent OsmAnd intake URL, or the tracking-device connection-profile endpoint. Secret-bearing material is only ever returned from this action, never from Device reads.
| device_id required | string <uuid> UUID of the device. |
TechnicianAppSetupCode
{- "device_id": "00000000-0000-4000-8000-000000004001",
- "type": "TOURFOLD_APP_ENROLLMENT",
- "expires_at": "2026-08-20T10:30:00Z"
}Sends a Tourfold App setup link to the device's stored phone number. The link carries a one-time enrollment secret and is delivered only in the SMS โ the response never includes the URL or secret. Supported for Tourfold App devices only, and only while the workspace's device fleet is admin-managed.
| device_id required | string <uuid> UUID of the device. |
TechnicianSetupSmsScheduled
{- "device_id": "00000000-0000-4000-8000-000000004001",
- "sent_to": "+4369917246437",
- "expires_at": "2026-08-20T10:30:00Z"
}Emails a Tourfold App setup link to the given address (for SIM-less devices where the SMS channel is unavailable). The link carries a one-time enrollment secret and is delivered only in the email โ the response never includes the URL or secret. Supported for Tourfold App devices only, and only while the workspace's device fleet is admin-managed.
| device_id required | string <uuid> UUID of the device. |
| email required | string <email> non-empty Email address to deliver the setup link to (chosen by the admin โ a device has no mailbox of its own). |
SendSetupEmailToAdmin
{- "email": "jonas.leitner@example.com"
}TechnicianSetupEmailSent
{- "device_id": "00000000-0000-4000-8000-000000004001",
- "sent_to": "jonas.leitner@example.com",
- "expires_at": "2026-08-20T10:30:00Z"
}Rotates the device intake secret, invalidating the previous one. Returns no body โ the new usable configuration (URL + secret) is obtained via the setup-codes action, keeping a single rendering path and never exposing the secret in a cacheable response.
| device_id required | string <uuid> UUID of the device. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Clears the device's registered credential so a reinstalled or replaced app can pair again under the same device id, with a setup link generated afterwards. The app currently installed on the device is signed out at once and stops reporting until it is set up again. Setup links generated before the reset stop working. The device keeps its vehicle connection, tours and history. Supported for Tourfold App devices only, and only while the workspace's device fleet is admin-managed.
| device_id required | string <uuid> UUID of the device. |
ResetTechnicianDeviceEnrollment
{- "device_id": "00000000-0000-4000-8000-000000004001",
- "enrolled": false,
- "connected_vehicle_id": "00000000-0000-4000-8000-000000005001",
- "connected_vehicle_on_active_tour": true
}Redeems the device's pairing secret and registers its public key as a per-device Keycloak client. After this the device authenticates to Keycloak by signature (private_key_jwt). Authenticated by the pairing secret, not a user token. Pairing succeeds once per device: a device that is already enrolled returns 409. After an admin resets the enrollment (resetDeviceEnrollment), a setup link generated afterwards pairs the device again.
| device_id required | string <uuid> UUID of the device. |
| X-Tenant-Id required | string <uuid> Workspace the device belongs to. Required because this operation is authenticated by the pairing secret in the body, not a bearer token, so no workspace context can be derived from a token. |
| secret required | string non-empty The pairing secret delivered to the device (the enrollment token). |
required | object non-empty The device's public key as an EC P-256 JWK (kty=EC, crv=P-256, x, y). |
| challenge | string The single-use nonce from |
object (DeviceAttestation) Platform attestation bound to |
EnrollIosDevice
{- "secret": "6b1f9a7c4d2e08b35fa17c9e3d4b8021",
- "public_key": {
- "kty": "EC",
- "crv": "P-256",
- "x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
- "y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}, - "challenge": "0f2c7d51-8a34-4d6b-9c1e-2f5b7a904e13",
- "attestation": {
- "platform": "IOS_APP_ATTEST",
- "key_id": "YXBwLWF0dGVzdC1rZXktaWQtZXhhbXBsZQ==",
- "attestation_object": "o2NmbXRvYXBwbGUtYXBwYXR0ZXN0Z2F0dFN0bXQ="
}
}{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Uploads the device's public key and registers it as a per-device Keycloak client, authorized by the user's token plus a platform attestation bound to the key. Like the pairing path, enrollment succeeds once per device: an already-enrolled device returns 409 and its key is never rotated through this endpoint. An install that lost its key (app reinstall) self-enrolls again under a fresh device_identity_id.
| device_id required | string <uuid> UUID of the device. |
required | object non-empty The device's public key as an EC P-256 JWK (kty=EC, crv=P-256, x, y). |
| challenge | string The single-use nonce from |
object (DeviceAttestation) Platform attestation bound to |
CompleteSelfEnrollment
{- "public_key": {
- "kty": "EC",
- "crv": "P-256",
- "x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
- "y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}, - "challenge": "0f2c7d51-8a34-4d6b-9c1e-2f5b7a904e13",
- "attestation": {
- "platform": "IOS_APP_ATTEST",
- "key_id": "YXBwLWF0dGVzdC1rZXktaWQtZXhhbXBsZQ==",
- "attestation_object": "o2NmbXRvYXBwbGUtYXBwYXR0ZXN0Z2F0dFN0bXQ="
}
}{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Issues a single-use nonce for a self-enrolled device to attest over before completing enrollment. The device attests to SHA256(nonce || public_key), binding the platform's proof to the exact key it is about to register. Authenticated by the user's token. An already-enrolled device is refused.
| device_id required | string <uuid> UUID of the device. |
SelfEnrollmentChallenge
{- "nonce": "0f2c7d51-8a34-4d6b-9c1e-2f5b7a904e13",
- "expires_at": "2026-08-20T08:05:00Z"
}Background auto-migration for an already-logged-in legacy device: authenticated by the device's existing legacy token (not a pairing secret), it uploads its public key and is issued a per-device Keycloak client. The tenant and device are taken from the verified token; the path device id must match the token's device id. Enrollment succeeds once per device: a device that already holds a Keycloak identity returns 409.
| device_id required | string <uuid> UUID of the device. |
required | object non-empty The device's public key as an EC P-256 JWK (kty=EC, crv=P-256, x, y). |
| challenge | string The single-use nonce from |
object (DeviceAttestation) Platform attestation bound to |
MigrateAndroidDevice
{- "public_key": {
- "kty": "EC",
- "crv": "P-256",
- "x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
- "y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}, - "challenge": "0f2c7d51-8a34-4d6b-9c1e-2f5b7a904e13",
- "attestation": {
- "platform": "ANDROID_PLAY_INTEGRITY",
- "package_name": "com.tourfold.main",
- "integrity_token": "eyJhbGciOiJSUzI1NiJ9.cGxheS1pbnRlZ3JpdHktdG9rZW4="
}
}{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Issues a single-use nonce for a pairing device to attest over before redeeming its pairing secret at POST /api/v2/devices/{device_id}/enroll. The pairing device holds no token, so the pairing secret authorizes the issuance โ like /enroll itself, this endpoint is authenticated by the secret, not a user token. An already-enrolled device is refused.
| device_id required | string <uuid> UUID of the device. |
| X-Tenant-Id required | string <uuid> Workspace the device belongs to. Required because this operation is authenticated by the pairing secret in the body, not a bearer token, so no workspace context can be derived from a token. |
| secret required | string non-empty The pairing secret delivered to the device (the enrollment token). |
PairingChallengeRequest
{- "secret": "6b1f9a7c4d2e08b35fa17c9e3d4b8021"
}PairingChallenge
{- "nonce": "0f2c7d51-8a34-4d6b-9c1e-2f5b7a904e13",
- "expires_at": "2026-08-20T08:05:00Z"
}Marks a device as inactive while keeping telemetry history and intake data.
| device_id required | string <uuid> UUID of the device. |
DeactivatedTechnicianDevice
{- "id": "00000000-0000-4000-8000-000000004001",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T10:00:00Z",
- "lock_version": 2,
- "natural_id": "MOB-17",
- "kind": "TOURFOLD_APP",
- "effective_app_location_tracking_policy": "continuous",
- "app_location_tracking_policy_source": "workspace",
- "device_model": "Pixel 9",
- "device_identity_id": "jonas-pixel-9",
- "provisioning_state": "DISABLED",
- "phone_number": "+4369917246437",
- "platform": "ANDROID",
- "logout_device_with_user": false,
- "self_enrolled": false,
- "enrolled": true,
- "description": "Jonas Leitner's service device"
}Marks an inactive device as provisioned and usable again.
| device_id required | string <uuid> UUID of the device. |
ActivatedTechnicianDevice
{- "id": "00000000-0000-4000-8000-000000004001",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T08:00:00Z",
- "lock_version": 0,
- "natural_id": "MOB-17",
- "kind": "TOURFOLD_APP",
- "effective_app_location_tracking_policy": "continuous",
- "app_location_tracking_policy_source": "workspace",
- "device_model": "Pixel 9",
- "device_identity_id": "jonas-pixel-9",
- "provisioning_state": "PROVISIONED",
- "phone_number": "+436641234567",
- "platform": "ANDROID",
- "logout_device_with_user": false,
- "self_enrolled": false,
- "enrolled": true,
- "description": "Jonas Leitner's service device"
}Registers the calling user's own device: creates the device row for this install, or returns the existing one โ idempotent on device_identity_id until enrollment completes; a colliding identity that already holds a key returns 409. Follow up with POST /api/v2/devices/{device_id}/enroll/self/challenge and POST /api/v2/devices/{device_id}/enroll/self to complete enrollment. Refused with 422 (devices/self-enrollment-not-allowed) on workspaces that provision devices through admin setup links.
| device_identity_id required | string [ 0 .. 255 ] characters Stable per-install identifier generated by the app. Stored alongside the device keypair, so an install that loses its key also loses this id and self-enrolls as a new device. |
| platform | string Enum: "UNKNOWN" "IOS" "ANDROID" Mobile platform of the device |
| device_model | string [ 0 .. 128 ] characters Human-readable device model |
| description | string Optional notes |
SelfEnrollIosDevice
{- "device_identity_id": "8f3a1c92-5d47-4e08-b6a1-0c7e2f4b93d5",
- "platform": "IOS",
- "device_model": "iPhone 15"
}ExistingSelfEnrolledDevice
{- "id": "00000000-0000-4000-8000-000000004002",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T08:00:00Z",
- "lock_version": 0,
- "natural_id": "MOB-18",
- "kind": "TOURFOLD_APP",
- "effective_app_location_tracking_policy": "continuous",
- "app_location_tracking_policy_source": "workspace",
- "device_model": "iPhone 15",
- "device_identity_id": "8f3a1c92-5d47-4e08-b6a1-0c7e2f4b93d5",
- "provisioning_state": "NOT_PROVISIONED",
- "platform": "IOS",
- "logout_device_with_user": false,
- "self_enrolled": true,
- "enrolled": false
}Issues a single-use nonce for the device to attest over before enrolling. The device attests to SHA256(nonce || public_key), binding the platform's proof to the exact key it is about to register. Authenticated by the device's existing legacy token; the device is taken from the verified token.
MigrationChallenge
{- "nonce": "0f2c7d51-8a34-4d6b-9c1e-2f5b7a904e13",
- "expires_at": "2026-08-20T08:05:00Z"
}Returns a device. Set include_deleted=true to read retained tracker history. Historical devices are read-only and have no current state.
| device_id required | string <uuid> UUID of the device. |
| include | Array of strings Items Value: "current_state" Example: include=current_state Optional related resources to embed. Supported: |
| include_deleted | boolean Default: false Include retained deleted tracker records. Requires the same workspace and read permission. |
TechnicianDevice
{- "id": "00000000-0000-4000-8000-000000004001",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T08:00:00Z",
- "lock_version": 0,
- "natural_id": "MOB-17",
- "kind": "TOURFOLD_APP",
- "effective_app_location_tracking_policy": "continuous",
- "app_location_tracking_policy_source": "workspace",
- "device_model": "Pixel 9",
- "device_identity_id": "jonas-pixel-9",
- "provisioning_state": "PROVISIONED",
- "phone_number": "+436641234567",
- "platform": "ANDROID",
- "logout_device_with_user": false,
- "self_enrolled": false,
- "enrolled": true,
- "description": "Jonas Leitner's service device"
}Deletes a device. Hardware trackers retain their telemetry and ended Vehicle assignments as read-only history and release their identifier after provider cleanup. End all current assignments first. A failed cleanup remains pending; retry DELETE. Repeating DELETE for a retained deleted tracker returns 204. App and OsmAnd devices are erased and cannot be deleted while they have assignment history.
| device_id required | string <uuid> UUID of the device. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON Merge Patch (RFC 7386): omitted fields remain unchanged; a field set to null is cleared (phone_number and description). Provisioning state is system-managed and cannot be changed through this endpoint.
| device_id required | string <uuid> UUID of the device. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check. Device telemetry does not advance it. |
| kind | string Enum: "TOURFOLD_APP" "THIRD_PARTY_OSMAND" "TRACKING_DEVICE" Device kind. Omitted leaves the value unchanged. Explicit null is rejected (422) โ kind is required and cannot be cleared. |
| device_model | string or null Human-readable model or tracker type. Omitted leaves the value unchanged; explicit null clears it. |
| device_identity_id | string or null Stable device identifier. Omitted leaves the value unchanged; explicit null clears it except for tracking hardware. Once set it cannot be changed to a different value. |
| connection_profile | string or null Provider connection profile selected for tracking hardware, for example OSMAND_HTTP_ONLY. Omitted leaves the value unchanged. Required and non-clearable for tracking hardware; not applicable to other kinds. |
| phone_number | string or null International phone number. An explicit '+' country code is required; common formatting is accepted and normalized to canonical E.164. National numbers are rejected. Omitted leaves the value unchanged; explicit null clears it. |
| platform | string Enum: "UNKNOWN" "IOS" "ANDROID" Mobile platform. Omitted leaves the value unchanged. Explicit null is rejected (422) โ platform is required and cannot be cleared. |
| description | string or null Optional operator notes. Omitted leaves the value unchanged; explicit null clears it. |
| logout_device_with_user | boolean or null When true, logging the human out also ends the device (telemetry) session. Omit to leave unchanged. |
| app_location_tracking_policy_override | string or null Enum: "disabled" "during_work" "continuous" null Tourfold app Devices only. Omit to preserve; null resumes inheritance; a value overrides the workspace policy. |
UpdateTechnicianPhone
{- "lock_version": 0,
- "phone_number": "+43 699 172 464 37"
}UpdatedTechnicianDevice
{- "id": "00000000-0000-4000-8000-000000004001",
- "created_at": "2026-08-20T08:00:00Z",
- "updated_at": "2026-08-20T09:30:00Z",
- "lock_version": 1,
- "natural_id": "MOB-17",
- "kind": "TOURFOLD_APP",
- "effective_app_location_tracking_policy": "continuous",
- "app_location_tracking_policy_source": "workspace",
- "device_model": "Pixel 9",
- "device_identity_id": "jonas-pixel-9",
- "provisioning_state": "PROVISIONED",
- "phone_number": "+4369917246437",
- "platform": "ANDROID",
- "logout_device_with_user": false,
- "self_enrolled": false,
- "enrolled": true,
- "description": "Jonas Leitner's service device"
}Returns whether the device's app install holds a registered credential, and what an enrollment reset would interrupt: the vehicle the device is connected to and whether that vehicle is on an active tour.
| device_id required | string <uuid> UUID of the device. |
EnrolledTechnicianDevice
{- "device_id": "00000000-0000-4000-8000-000000004001",
- "enrolled": true,
- "connected_vehicle_id": "00000000-0000-4000-8000-000000005001",
- "connected_vehicle_on_active_tour": true
}Returns the latest materialized state (status, location, battery, app) for one device.
| device_id required | string <uuid> UUID of the device. |
TechnicianDeviceCurrentState
{- "device_id": "00000000-0000-4000-8000-000000004001",
- "last_seen_at": "2026-08-20T09:29:45Z",
- "status": {
- "connectivity": "ONLINE",
- "updated_at": "2026-08-20T09:29:45Z"
}
}Returns neutral supported device kinds and setup profiles. Provider internals and credentials are not exposed.
SupportedTrackingDevice
{- "items": [
- {
- "kind": "TRACKING_DEVICE",
- "connection_profiles": [
- {
- "id": "OSMAND_HTTP_ONLY",
- "label": "OsmAnd compatible HTTP only",
- "protocol": "OsmAnd HTTP",
- "identity_label": "Device ID",
- "identity_required": true,
- "setup": {
- "server": "device-intake.tourfold.com",
- "port": 5055,
- "protocol": "OsmAnd HTTP"
}, - "compatible_devices": [
- "OsmAnd compatible tracker"
]
}
]
}
]
}Returns the latest materialized state for the requested, tenant-visible devices, ordered by device UUID ascending. Duplicate ids are returned once; unknown or other-tenant ids are omitted. Requires 1โ100 ids, counting duplicates, supplied as repeated device_ids parameters.
| device_ids required | Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ] Required device UUIDs, from 1 to 100 values. Repeat the device_ids query parameter for each value; CSV and blank values are rejected. |
TechnicianDeviceCurrentStates
{- "items": [
- {
- "device_id": "00000000-0000-4000-8000-000000004001",
- "last_seen_at": "2026-08-20T09:29:45Z",
- "status": {
- "connectivity": "ONLINE",
- "updated_at": "2026-08-20T09:29:45Z"
}
}
]
}Resolve a concrete Task definition by UUID or slug in the Task family.
| definition_ref required | string Concrete Task definition UUID or slug |
| If-None-Match | string Optional ETag for conditional revalidation |
inspection
{- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Atomically replace the full authored schema. Missing attributes are removed subject to usage guards. Execution type is immutable. Omitted or null natural_id_key clears the prefix; all Tasks retain their shared sequence. Stable IDs or unchanged slugs preserve attribute identity. System definitions are protected.
| definition_ref required | string Concrete Task definition UUID or slug |
| slug required | string <= 63 characters ^[a-z][a-z0-9_]*$ Tenant Task definition slug; managed prefixes and reserved names are forbidden. |
required | object Localized singular/plural names. |
| execution_type required | string Enum: "simple" "workflow_single_choice_question" "workflow_free_text_question" "visit" Immutable system execution type. Only simple and visit can be extended. |
| natural_id_key | string or null <= 16 characters ^[A-Z][A-Z0-9]{0,15}$ Optional workspace-unique presentation prefix. All Tasks share one numeric sequence regardless of definition. Omitted or null means no prefix. |
required | Array of any (AttributeInput) <= 20 items Authored custom fields only. Native fields cannot be overridden; Task targets and reverse fields are not supported. |
| lock_version | integer <int64> >= 0 Optional version precondition. Omitted or null skips the client version check; stale values return 409. |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon key from the client icon catalog, for example |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Palette color of the definition icon. Omission or null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Attribute slugs shown, in order, under the record name and the clicked location in a map popup, for example |
inspection
{- "slug": "inspection",
- "execution_type": "simple",
- "natural_id_key": "INS",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "attributes": [ ],
- "lock_version": 0
}inspection
{- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Delete a tenant definition only when no Task or persisted configuration dependency uses it. Completed Tasks also block deletion. System definitions are protected.
| definition_ref required | string Concrete Task definition UUID or slug |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Merge localized names, rename a tenant definition or change its optional natural_id_key prefix. Omitted prefix is preserved; null clears it. Renaming is blocked while used; labels and prefixes remain editable. System definitions allow prefix-only updates. Null slug or root name is invalid.
| definition_ref required | string Concrete Task definition UUID or slug |
| slug | string <= 63 characters New slug; null is rejected. UUID stays stable. Rename is blocked once the definition is used. |
object Merge by language and noun form. A null language removes its translation. Empty maps preserve values. At least one localized name must remain; root null is rejected. | |
| natural_id_key | string or null <= 16 characters ^[A-Z][A-Z0-9]{0,15}$ Workspace-unique presentation prefix. Omission preserves it; null removes it. May change on system or in-use definitions without renumbering Tasks. |
| lock_version | integer or null <int64> >= 0 Optional version precondition; stale versions return 409. Omitted or null skips the client check. |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon catalog key. Omission preserves it; null restores the default icon. |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Icon background palette color. Omission preserves it; null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Ordered popup field selection. Omission preserves it; null clears it to an empty list; an array replaces it. Lists and structured JSON fields are unsupported. |
inspection
{- "name": {
- "en": {
- "plural": "Site inspections"
}
}, - "lock_version": 0
}inspection
{- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Site inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Search slug and localized names before pagination. Fixed order: system Simple, Visit, single-choice question, free-text question; then custom slug and UUID. The Task family root is excluded.
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| search | string [ 1 .. 256 ] characters Case-insensitive slug or localized-name substring; blank is rejected |
| If-None-Match | string Optional ETag for conditional revalidation |
inspection
{- "items": [
- {
- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Create an extension of system Simple or Visit. Workflow question bases and custom definitions cannot be extended. Native fields cannot be overridden.
| slug required | string <= 63 characters ^[a-z][a-z0-9_]*$ Tenant Task definition slug; managed prefixes and reserved names are forbidden. |
required | object Localized singular/plural names. |
| execution_type required | string Enum: "simple" "workflow_single_choice_question" "workflow_free_text_question" "visit" Immutable system execution type. Only simple and visit can be extended. |
| natural_id_key | string or null <= 16 characters ^[A-Z][A-Z0-9]{0,15}$ Optional workspace-unique presentation prefix. All Tasks share one numeric sequence regardless of definition. Omitted or null means no prefix. |
Array of any (AttributeInput) <= 20 items Authored custom fields only. Native fields cannot be overridden; Task targets and reverse fields are not supported. | |
| icon | string or null <= 64 characters ^[a-z0-9]+(-[a-z0-9]+)*$ Icon key from the client icon catalog, for example |
| color | string or null Enum: "gray" "red" "orange" "amber" "green" "teal" "blue" "indigo" "violet" "pink" null Palette color of the definition icon. Omission or null means transparent. |
| map_marker_fields | Array of strings or null <= 100 items Attribute slugs shown, in order, under the record name and the clicked location in a map popup, for example |
inspection
{- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "attributes": [ ]
}inspection
{- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Add a custom attribute. While the definition is used, only optional fields without new uniqueness/indexing obligations are allowed. Defaults apply to future creation only. Returns the updated definition.
| definition_ref required | string Concrete Task definition UUID or slug |
| id | string <uuid> Existing attribute id (omit on create; send to update/rename) |
| slug required | string <= 200 characters ^[a-z][a-z0-9_]*$ Attribute slug; self, this and platform record fields are reserved. |
| type required | string Attribute type selecting this configuration. |
object Attribute label per language tag, e.g. {"en": "Purchase price"} | |
| description | string Optional attribute description |
object (TextAttributeConfigInput) Configuration for text attributes. | |
| lock_version | integer <int64> Optimistic-locking version: validated against the stored version when provided (409 on mismatch); omitting it skips the concurrency check |
inspection
{- "slug": "notes",
- "type": "text",
- "name": {
- "en": "Notes"
}
}inspection
{- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 1,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "id": "21d3f004-0000-4000-8000-000000000003",
- "slug": "notes",
- "type": "text",
- "name": {
- "en": "Notes"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Remove an authored attribute and its storage only when the definition is unused. Returns the complete updated definition. System definitions are protected.
| definition_ref required | string Concrete Task definition UUID or slug |
| attribute_ref required | string Authored attribute UUID or slug |
inspection
{- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 2,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Merge an authored attribute by UUID or slug. Omitted fields stay unchanged; choice arrays replace their set. While used, only labels, descriptions and presentation order may change. Type, uniqueness, cardinality and target changes are unsupported even when unused.
| definition_ref required | string Concrete Task definition UUID or slug |
| attribute_ref required | string Authored attribute UUID or slug |
| id | string or null <uuid> Optional identity assertion; must match the routed attribute. |
| type | string or null Enum: "text" "license_plate" "vin" "number" "date" "date_time" "boolean" "select" "state" "capacity" "measure" "currency" "rating" "email" "phone" "tags" "required_skills" "provided_skills" "relationship" "location" "raw_json" "rich_text" "full_name" "links" null Optional type assertion; cannot change the stored type. |
| slug | string <= 200 characters ^[a-z][a-z0-9_]*$ New slug. Omission preserves it; null cannot clear it. |
object Merge localized labels. Null at a language key removes that translation. | |
| description | string or null Null clears the description; blank text is rejected. |
object or null Merge type-specific configuration keys with the stored configuration. Null clears an optional setting; null config resets optional configuration. Required settings, immutable uniqueness, unknown keys and keys belonging to another type are validated after merging. | |
Array of objects (SelectOptionInput) Select only: replaces choices; [] clears them. Existing choice IDs preserve stored values. | |
Array of objects (StateInput) State only: replaces states; [] clears them. Existing state IDs preserve stored values. | |
| lock_version | integer or null <int64> >= 0 Optional definition version precondition. |
inspection
{- "name": {
- "en": "Inspection notes"
}, - "lock_version": 1
}inspection
{- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "natural_id_key": "INS",
- "execution_type": "simple",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "is_extendable": false,
- "managed_by": "tenant",
- "schema_policy": "editable",
- "created_at": "2023-02-14T10:00:00Z",
- "updated_at": "2023-02-14T10:00:00Z",
- "lock_version": 2,
- "attributes": [
- {
- "slug": "id",
- "type": "text",
- "name": {
- "en": "ID"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "created_at",
- "type": "date_time",
- "name": {
- "en": "Created at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "updated_at",
- "type": "date_time",
- "name": {
- "en": "Updated at"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "gt",
- "gte",
- "lt",
- "lte"
]
}, - {
- "slug": "lock_version",
- "type": "number",
- "name": {
- "en": "Lock version"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "slug": "definition_id",
- "type": "text",
- "name": {
- "en": "Definition"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "natural_id",
- "type": "text",
- "name": {
- "en": "Task number"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "type",
- "type": "text",
- "name": {
- "en": "Task type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "execution_type",
- "type": "text",
- "name": {
- "en": "Execution type"
}, - "is_system_managed": true,
- "is_readonly": true,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "title",
- "type": "text",
- "name": {
- "en": "Title"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "status",
- "type": "text",
- "name": {
- "en": "Status"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with"
], - "config": {
- "is_required": true,
- "is_unique": false
}
}, - {
- "slug": "assignee_user_id",
- "type": "text",
- "name": {
- "en": "Assignee"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}, - {
- "slug": "linked_records",
- "type": "json",
- "name": {
- "en": "Linked records"
}, - "is_system_managed": true,
- "is_readonly": false,
- "is_sortable": false,
- "filter_operators": [ ]
}, - {
- "id": "21d3f004-0000-4000-8000-000000000003",
- "slug": "notes",
- "type": "text",
- "name": {
- "en": "Inspection notes"
}, - "is_system_managed": false,
- "is_readonly": false,
- "is_sortable": true,
- "filter_operators": [
- "eq",
- "ne",
- "in",
- "contains",
- "starts_with",
- "ends_with",
- "is_null"
], - "config": {
- "is_required": false,
- "is_unique": false
}
}
], - "resource_type": "task",
- "is_readonly": false,
- "is_relationship_target": false,
- "map_marker_fields": [ ]
}Manage MCP server settings for the tenant. Controls whether MCP is enabled and which operations are allowed.
Partially updates the MCP server settings. Omit a field to leave it unchanged. Set mode to OFF to disable MCP entirely, READ_ONLY to allow read operations only, or READ_WRITE to allow all operations.
| mode | string Enum: "OFF" "READ_ONLY" "READ_WRITE" New operating mode. Omit to leave unchanged; explicit null is rejected (422). |
EnableReadOnlyMcp
{- "mode": "READ_ONLY"
}UpdatedReadOnlyMcpSettings
{- "mode": "READ_ONLY",
- "tenant_id": "00000000-0000-4000-8000-000000000001"
}Customer workflow execution history. Requires workflows:manage, including access to captured inputs.
Requires workflows:manage. Lists stored runs for one workflow without decrypting inputs. Includes retained runs after workflow deletion.
| workflow_id required | string <uuid> Owning workflow UUID, including retained deleted workflows |
| status | string Enum: "queued" "running" "succeeded" "failed" "timed_out" "cancelled" "terminated" Exact stored run status; omitted includes all statuses |
| created_from | string <date-time> Inclusive lower bound on created_at, RFC 3339 with explicit offset |
| created_to | string <date-time> Exclusive upper bound on created_at, RFC 3339 with explicit offset; must be later than created_from |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| sort | string Default: "created_at:desc" Enum: "created_at" "created_at:asc" "created_at:desc" "id" "id:asc" "id:desc" One field[:direction] criterion: created_at or id, asc/desc. Omitted direction means asc; default created_at:desc with stable id tie-breaker. |
| object_id | string <uuid> Exact triggering object UUID captured at admission. Combined with other filters before count and pagination; does not decrypt inputs or require the object to still exist. |
| record_id | string <uuid> Exact triggering record UUID captured at admission. Combined with object_id when supplied; includes retained runs after record deletion and does not decrypt inputs. |
| version_id | string <uuid> Exact pinned workflow version UUID belonging to this workflow |
QueuedRuns
{- "items": [
- {
- "id": "10000000-1111-2222-3333-000000000001",
- "workflow_id": "20000000-1111-2222-3333-000000000001",
- "workflow_name": "Follow up with Acme",
- "version_id": "30000000-1111-2222-3333-000000000001",
- "status": "queued",
- "created_at": "2026-09-05T10:00:00Z"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Admits an enabled manual_record publication for an accessible current record. Requires workflows:manage and objects:records:read; Script/Agent workflows also require workflows:code:execute. The reviewed version_id must still be current. Execution is asynchronous through the ordinary durable outbox. Repeating the same request_id, publication, record and actor returns the same run without new effects, even if the workflow was subsequently edited or disabled. Use a new request_id only for a deliberate new run, which may repeat effects.
| workflow_id required | string <uuid> Workflow UUID in the current tenant |
| request_id required | string <uuid> Client-generated UUID for one intended run. Reuse on retry; generate another for a deliberate new run. |
| version_id required | string <uuid> Exact reviewed workflow publication UUID; must be the current enabled manual-record publication for a new request. |
| record_id required | string <uuid> Accessible current record UUID belonging to the publication's trigger object. |
object Values for every declared start input in the reviewed publication. Exact names and scalar types, at most 16 and 16 KiB. Omission is an empty object; null and undeclared names are rejected. Preserve these values across retries. |
ReviewedRecordRun
{- "request_id": "00000000-0000-4000-8000-000000000901",
- "version_id": "00000000-0000-4000-8000-000000000902",
- "record_id": "00000000-0000-4000-8000-000000000903"
}AdmittedRun
{- "id": "10000000-1111-2222-3333-000000000001",
- "workflow_id": "20000000-1111-2222-3333-000000000001",
- "version_id": "30000000-1111-2222-3333-000000000001",
- "trigger_id": "40000000-1111-2222-3333-000000000001",
- "source_event_id": "50000000-1111-2222-3333-000000000001",
- "status": "queued",
- "created_at": "2026-09-05T10:00:00Z",
- "trigger_input": {
- "type": "record",
- "object_id": "60000000-1111-2222-3333-000000000001",
- "record_id": "70000000-1111-2222-3333-000000000001",
- "revision": 0,
- "display_name": "Acme",
- "text_fields": {
- "name": "Acme"
}, - "occurred_at": "2026-09-05T10:00:00Z",
- "changed_field_paths": [ ],
- "number_fields": { },
- "boolean_fields": { },
- "date_time_fields": { }
}, - "steps": [
- {
- "id": "90000000-1111-2222-3333-000000000001",
- "node_id": "80000000-1111-2222-3333-000000000001",
- "status": "pending",
- "action_type": "create_task",
- "interactions": [ ],
- "input": {
- "title": "Follow up with Acme",
- "linked_records": [ ]
}
}
]
}Requires workflows:manage. Atomically records cancellation and prevents new workflow effects, closes pending question Tasks, then delivers cancellation asynchronously to the exact execution. Previously committed effects remain. Repeating a pending request returns 202 without creating another request; an already observed terminal run returns 200 unchanged. Inspect cancellation_requested_at and status: a concurrent completion may win. No request body is required.
| workflow_id required | string <uuid> Owning workflow UUID, including retained deleted workflows |
| run_id required | string <uuid> Tourfold run UUID in this tenant, captured at admission |
AlreadyCompleted
{- "id": "10000000-1111-2222-3333-000000000001",
- "workflow_id": "20000000-1111-2222-3333-000000000001",
- "version_id": "30000000-1111-2222-3333-000000000001",
- "trigger_id": "40000000-1111-2222-3333-000000000001",
- "source_event_id": "50000000-1111-2222-3333-000000000001",
- "status": "succeeded",
- "created_at": "2026-09-05T10:00:00Z",
- "completed_at": "2026-09-05T10:00:02Z",
- "trigger_input": {
- "type": "record",
- "object_id": "60000000-1111-2222-3333-000000000001",
- "record_id": "70000000-1111-2222-3333-000000000001",
- "revision": 0,
- "display_name": "Acme",
- "text_fields": {
- "name": "Acme"
}, - "occurred_at": "2026-09-05T10:00:00Z",
- "changed_field_paths": [ ],
- "number_fields": { },
- "boolean_fields": { },
- "date_time_fields": { }
}, - "steps": [
- {
- "id": "90000000-1111-2222-3333-000000000001",
- "node_id": "80000000-1111-2222-3333-000000000001",
- "status": "succeeded",
- "action_type": "end",
- "interactions": [ ],
- "completed_at": "2026-09-05T10:00:02Z"
}
]
}Requires workflows:manage. Returns immutable trigger input, ordered logical steps, committed Task and record links, sanitized errors and confirmed usage. include=version expands the pinned publication one level, including after workflow deletion. Captured data uses workflow authority; ordinary Task/record links retain their own access checks.
| workflow_id required | string <uuid> Owning workflow UUID, including retained deleted workflows |
| run_id required | string <uuid> Tourfold run UUID in this tenant, captured at admission |
| include | Array of strings <= 1 items unique Items Value: "version" One-level inline expansion; only version is supported. Repeat include for multiple values; CSV is unsupported. |
QueuedRun
{- "id": "10000000-1111-2222-3333-000000000001",
- "workflow_id": "20000000-1111-2222-3333-000000000001",
- "version_id": "30000000-1111-2222-3333-000000000001",
- "trigger_id": "40000000-1111-2222-3333-000000000001",
- "source_event_id": "50000000-1111-2222-3333-000000000001",
- "status": "queued",
- "created_at": "2026-09-05T10:00:00Z",
- "trigger_input": {
- "type": "record",
- "object_id": "60000000-1111-2222-3333-000000000001",
- "record_id": "70000000-1111-2222-3333-000000000001",
- "revision": 0,
- "display_name": "Acme",
- "text_fields": {
- "name": "Acme"
}, - "occurred_at": "2026-09-05T10:00:00Z",
- "changed_field_paths": [ ],
- "number_fields": { },
- "boolean_fields": { },
- "date_time_fields": { }
}, - "steps": [
- {
- "id": "90000000-1111-2222-3333-000000000001",
- "node_id": "80000000-1111-2222-3333-000000000001",
- "status": "pending",
- "action_type": "create_task",
- "interactions": [ ],
- "input": {
- "title": "Follow up with Acme",
- "linked_records": [ ]
}
}
]
}Requires workflows:manage. Returns all ordered logical executions in the bounded graph, including pinned inputs, committed outcomes, sanitized errors and usage. Retained after workflow deletion.
| workflow_id required | string <uuid> Owning workflow UUID, including retained deleted workflows |
| run_id required | string <uuid> Run UUID belonging to this workflow |
RunSteps
{- "items": [
- {
- "id": "90000000-1111-2222-3333-000000000001",
- "node_id": "80000000-1111-2222-3333-000000000001",
- "status": "pending",
- "action_type": "end",
- "interactions": [ ]
}
]
}Requires workflows:manage. Resolves the logical execution identity within the pinned run before loading retained content. node_id identifies the authored graph node. Includes committed results independently of the paginated event collection.
| workflow_id required | string <uuid> Owning workflow UUID, including retained deleted workflows |
| run_id required | string <uuid> Run UUID belonging to this workflow |
| step_execution_id required | string <uuid> Logical step execution UUID from run inspection; distinct from node_id |
PendingStep
{- "id": "90000000-1111-2222-3333-000000000001",
- "node_id": "80000000-1111-2222-3333-000000000001",
- "status": "pending",
- "action_type": "end",
- "interactions": [ ]
}Requires workflows:manage. Returns bounded customer Agent messages, permitted tool proposals, native web activity and committed READ outcomes in stable execution order. Verifies every parent before decrypting only the requested page. Non-Agent steps currently return an empty list. Retained deleted-workflow runs remain readable. Partial events explicitly mark pending/malformed/missing content; expired events omit all conversational content and links. Private instructions, internal reasoning, provider identifiers and raw envelopes are never returned. Does not contact external providers. Usage and accepted final output remain available in step inspection independently of event retention.
| workflow_id required | string <uuid> Workflow UUID owning the retained run |
| run_id required | string <uuid> Run UUID belonging to this workflow |
| step_execution_id required | string <uuid> Opaque step execution UUID belonging to this run; distinct from node_id |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Events per page |
RetainedWebActivity
{- "items": [
- {
- "type": "assistant_turn",
- "id": "00000000-0000-4000-8000-000000000001",
- "sequence": 0,
- "occurred_at": "2023-02-14T09:00:00Z",
- "availability": "retained",
- "expires_at": "2023-03-16T09:00:00Z",
- "segments": [
- {
- "type": "web_activity",
- "tool": {
- "name": "web.search",
- "version": 1
}, - "status": "completed",
- "query": "Product guide",
}, - {
- "type": "message",
- "text": "I found the product guide.",
}
]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Requires workflows:manage. Reads metadata without decrypting inputs. Includes retained runs of deleted workflows.
| workflow_id | string <uuid> Exact workflow UUID; omitted includes all workflows |
| status | string Enum: "queued" "running" "succeeded" "failed" "timed_out" "cancelled" "terminated" Exact stored run status; omitted includes all statuses |
| created_from | string <date-time> Inclusive lower bound on created_at, RFC 3339 with explicit offset |
| created_to | string <date-time> Exclusive upper bound on created_at, RFC 3339 with explicit offset; must be later than created_from |
| page | integer <int32> >= 0 Default: 0 Zero-based page |
| size | integer <int32> [ 1 .. 100 ] Default: 20 Items per page |
| sort | string Default: "created_at:desc" Enum: "created_at" "created_at:asc" "created_at:desc" "id" "id:asc" "id:desc" One field[:direction] criterion: created_at or id, asc/desc. Omitted direction means asc; default created_at:desc with stable id tie-breaker. |
| object_id | string <uuid> Exact triggering object UUID captured at admission. Combined with other filters before count and pagination; does not decrypt inputs or require the object to still exist. |
| record_id | string <uuid> Exact triggering record UUID captured at admission. Combined with object_id when supplied; includes retained runs after record deletion and does not decrypt inputs. |
| version_id | string <uuid> Exact pinned workflow version UUID; when workflow_id is supplied the version must belong to it |
QueuedRuns
{- "items": [
- {
- "id": "10000000-1111-2222-3333-000000000001",
- "workflow_id": "20000000-1111-2222-3333-000000000001",
- "workflow_name": "Follow up with Acme",
- "version_id": "30000000-1111-2222-3333-000000000001",
- "status": "queued",
- "created_at": "2026-09-05T10:00:00Z"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Phone-fix predictions a provider computes for a reported breakdown symptom, from the data it holds for the vehicle.
Newest first, then by id; case-reported and operator-asked alike. Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection, including ended ones |
| page | integer <int32> >= 0 Default: 0 |
| size | integer <int32> [ 1 .. 100 ] Default: 20 |
example
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000071",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "symptom": "wont_start",
- "status": "succeeded",
- "requested_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:00:03Z",
- "finished_at": "2023-02-14T10:00:04Z",
- "attempts": 1,
- "probability": 0.019,
- "baseline_probability": 0.018,
- "provider_vehicle_id": "7f3a",
- "reporting_case": {
- "id": "00000000-0000-4000-8000-000000000081",
- "external_id": "6516117213",
- "reported_fault": {
- "component_code": 100,
- "component": "Engine",
- "fault_code": 12,
- "fault": "Does not start"
}, - "mapping_rule": "Component 100 (Engine) with fault 12 (Does not start)"
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Queues the prediction and answers 202 with it; the worker asks the provider, which computes it from the data it already holds, and the prediction is read at Location. Nothing is read from the vehicle and nothing is billed. Repeating a request_id with the same symptom returns the same prediction in its current state. Needs vehicles:read and connected-vehicles:data-operations:write, and the connected-vehicles entitlement.
| connection_id required | string <uuid> UUID of the provider connection |
| request_id required | string <uuid> Your key for this request. Repeating it with the same symptom returns the same prediction; with another symptom it conflicts. |
| symptom required | string (VehiclePhoneFixSymptom) Enum: "accelerator_throttle_issue" "accident_damage_theft" "adblue_fault_warning" "adblue_refill_message" "airbag_warning" "alternator_belt" "alternator_issue" "amber_warning_light" "battery_assistance_needed" "battery_flat" "battery_warning_light" "bodywork_issue" "bonnet_boot_door_issue" "brake_pad_wear" "brake_system" "central_locking" "climate_control_issue" "coolant_level_warning" "cooling_fan_issue" "cooling_system" "cv_joint_issue" "dashboard_info_message" "dashboard_warning_light" "door_jammed" "dpf_warning" "electrical_system_reset" "electronic_systems" "engine_cutting_out" "engine_mechanical" "engine_misfire_running_rough" "engine_mount" "engine_noise" "exhaust_smoke" "fluid_leak" "fluid_loss_warning" "fuel_cap_jammed" "fuel_issue" "fuel_leak_smell" "fuel_starvation" "fuel_system" "fuse_issue" "glow_plug_warning" "hybrid_warning_light" "ignition_key_stuck" "ignition_key_wont_turn" "indicator_hazard_lights" "information_request" "key_issue" "key_lost_stolen" "keyless_entry_issue" "loss_of_power" "no_issue_specified" "noise_from_vehicle" "oil_leak_loss" "oil_level_warning" "oil_pressure_warning" "oil_sump_issue" "other_issue" "overheating" "puncture_issue" "recovery_diagnosis_needed" "red_warning_light" "running_rough" "seat_adjustment" "security_system" "steering_locked" "steering_power_steering" "suspension_vibration" "technical_advice_request" "transmission" "turbo_hose_issue" "tyre_pressure_warning" "vehicle_stuck" "vehicle_stuck_stranded" "warning_light_other" "wheel_noise" "wheel_tyre_issue" "windows_wipers" "wont_start" The symptom the driver reported, in the provider's vocabulary. |
wont_start
{- "request_id": "6a2c1d4e-9f0b-4c3a-8e7d-5b6a7c8d9e0f",
- "symptom": "wont_start"
}queued
{- "id": "00000000-0000-4000-8000-000000000071",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "symptom": "wont_start",
- "status": "queued",
- "requested_at": "2023-02-14T10:00:00Z",
- "attempts": 0
}Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection |
| prediction_id required | string <uuid> UUID of the prediction |
answered
{- "id": "00000000-0000-4000-8000-000000000071",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "symptom": "wont_start",
- "status": "succeeded",
- "requested_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:00:03Z",
- "finished_at": "2023-02-14T10:00:04Z",
- "attempts": 1,
- "probability": 0.019,
- "baseline_probability": 0.018,
- "provider_vehicle_id": "7f3a",
- "reporting_case": {
- "id": "00000000-0000-4000-8000-000000000081",
- "external_id": "6516117213",
- "reported_fault": {
- "component_code": 100,
- "component": "Engine",
- "fault_code": 12,
- "fault": "Does not start"
}, - "mapping_rule": "Component 100 (Engine) with fault 12 (Does not start)"
}
}The provider's body and the HTTP exchanges, credentials redacted. Needs vehicles:read and connected-vehicles:raw-data:read.
| connection_id required | string <uuid> UUID of the provider connection |
| prediction_id required | string <uuid> UUID of the prediction |
answered
{- "raw_payload": {
- "probability": 0.019,
- "symptom": "wont_start",
- "vehicle_id": "7f3a"
}, - "exchange_log": [
- {
- "method": "GET",
- "status": 200,
- "duration_ms": 164
}
]
}Returns the entries stored directly on the folder (one per principal: everyone / role / user), for rendering the permissions editor. For a top-level folder with no entries of its own, the tenant-wide default matrix it effectively resolves to is returned instead, flagged via from_tenant_default. An empty list on a non-root folder means it inherits its parent. Requires the documents:read grant to reach the feature and, per folder, either the documents:edit_permissions grant or ownership โ otherwise 403.
| folder_id required | string <uuid> UUID of the folder. |
EquipmentManualPermissions
{- "folder_id": "00000000-0000-4000-8000-000000007001",
- "entries": [
- {
- "principal_type": "role",
- "role_name": "technician",
- "level": "write"
}, - {
- "principal_type": "user",
- "user_id": "00000000-0000-4000-8000-000000001001",
- "user_name": "Mara Berger",
- "level": "write"
}
], - "inherited": false
}Stores the supplied entries as the folder's complete set (a replace, not a merge); an empty list clears them so the folder inherits. everyone may coexist with role/user entries. Requires the documents:read grant plus, per folder, the documents:edit_permissions grant or ownership. Returns the saved entries.
| folder_id required | string <uuid> UUID of the folder. |
required | Array of objects (PermissionEntryInput) The complete list of entries the folder should have after this call. | ||||||||
Array
| |||||||||
ReplaceEquipmentManualPermissions
{- "entries": [
- {
- "principal_type": "role",
- "role_name": "technician",
- "level": "write"
}, - {
- "principal_type": "user",
- "user_id": "00000000-0000-4000-8000-000000001001",
- "level": "write"
}
]
}ReplacedEquipmentManualPermissions
{- "folder_id": "00000000-0000-4000-8000-000000007001",
- "entries": [
- {
- "principal_type": "role",
- "role_name": "technician",
- "level": "write"
}, - {
- "principal_type": "user",
- "user_id": "00000000-0000-4000-8000-000000001001",
- "user_name": "Mara Berger",
- "level": "write"
}
], - "inherited": false
}Returns the entries stored directly on the document (one per principal: everyone / role / user), for rendering the permissions editor. An empty list means the document has no override and inherits its folder. Requires the documents:read grant to reach the feature and, per document, permission-management rights (the document's creator, the owning folder's manager, or the documents:edit_permissions grant) โ otherwise 403.
| document_id required | string <uuid> UUID of the document. |
ServiceManualPermissions
{- "document_id": "00000000-0000-4000-8000-000000007101",
- "entries": [
- {
- "principal_type": "user",
- "user_id": "00000000-0000-4000-8000-000000001002",
- "user_name": "Jonas Leitner",
- "level": "write"
}
], - "inherited": false
}Stores the supplied entries as the document's complete override set (a replace, not a merge); an empty list clears the override so the document inherits its folder again. everyone may coexist with role/user entries. Requires the documents:read grant plus, per document, permission-management rights (the document's creator, the owning folder's manager, or the documents:edit_permissions grant). Returns the saved entries.
| document_id required | string <uuid> UUID of the document. |
required | Array of objects (PermissionEntryInput) The complete list of entries the document should have after this call. | ||||||||
Array
| |||||||||
ReplaceServiceManualPermissions
{- "entries": [
- {
- "principal_type": "user",
- "user_id": "00000000-0000-4000-8000-000000001002",
- "level": "write"
}
]
}ReplacedServiceManualPermissions
{- "document_id": "00000000-0000-4000-8000-000000007101",
- "entries": [
- {
- "principal_type": "user",
- "user_id": "00000000-0000-4000-8000-000000001002",
- "user_name": "Jonas Leitner",
- "level": "write"
}
], - "inherited": false
}Returns folders that are direct children of parent_id (or root folders when parent_id is omitted), paginated in ascending name order. Default page size is 20, capped at 100. Folders of kind = managed_branch whose namespace is owned by a registered managed-folder provider are auto-expanded: the response surfaces one folder per managed subject at this depth, lazy-creating any missing rows. The provider's order is authoritative for managed pages. Requires the documents:read grant.
| parent_id | string <uuid> Parent folder id; omit for root listing. |
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
AlpineRootFolders
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000008001",
- "lock_version": 0,
- "name": "Equipment manuals",
- "display_name": "Equipment manuals",
- "kind": "user",
- "created_at": "2026-08-20T08:15:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a folder under the given parent (or at the root if no parent is supplied). Requires the documents:create grant.
| name required | string Display name of the folder. Validated server-side: NFC-normalized, max 255 codepoints, no path separators / control chars / Windows-reserved characters, not a reserved name. |
| parent_id | string <uuid> Parent folder id. Omit for a top-level folder. |
CreateEquipmentManualsFolder
{- "name": "Equipment manuals"
}CreatedEquipmentManualsFolder
{- "id": "00000000-0000-4000-8000-000000008001",
- "lock_version": 0,
- "name": "Equipment manuals",
- "display_name": "Equipment manuals",
- "kind": "user",
- "created_at": "2026-08-20T08:15:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Idempotent: re-starring a folder is a no-op and returns the same detail response with starred=true. Requires the documents:update grant.
| folder_id required | string <uuid> UUID of the folder. |
StarredEquipmentManualsFolder
{- "id": "00000000-0000-4000-8000-000000008001",
- "lock_version": 0,
- "name": "Equipment manuals",
- "display_name": "Equipment manuals",
- "kind": "user",
- "created_at": "2026-08-20T08:15:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "starred": true,
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Idempotent: un-starring a folder that was not starred is a no-op. Returns the folder detail with starred=false. Requires the documents:update grant.
| folder_id required | string <uuid> UUID of the folder. |
UnstarredEquipmentManualsFolder
{- "id": "00000000-0000-4000-8000-000000008001",
- "lock_version": 0,
- "name": "Equipment manuals",
- "display_name": "Equipment manuals",
- "kind": "user",
- "created_at": "2026-08-20T08:15:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "starred": false,
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Asynchronously extracts structured fields from the version. The call returns immediately with a document-management extraction id. Clients should listen for events.documents SSE lifecycle events and may poll GET /documents/extractions/{extraction_id} as a fallback until the status reaches a terminal state. Each call appends a new extraction (re-analysis is supported by submitting again). Terminal payloads are copied into document-management before the analyzer job is acked. Requires the documents:update grant.
| document_id required | string <uuid> UUID of the document. |
| version_id required | string <uuid> UUID of the document version. |
Rtu17AnalysisAccepted
{- "extraction_id": "00000000-0000-4000-8000-000000008005",
- "status": "pending"
}Creates a new draft [DocumentVersion] with version_number = max + 1, returns a presigned upload form. The current version pointer does NOT change until POST /documents/{document_id}/finalize is called. Requires the documents:update grant.
| document_id required | string <uuid> UUID of the document. |
| mime_type required | string non-empty MIME type of the file being uploaded. Must equal the document's current MIME type โ uploading a different content type creates a different document, not a new version. Mismatches are rejected with |
| original_file_name | string Filename of the file being uploaded (e.g. |
| change_note | string Optional free-form note describing what's new in this version. Stored on the version row. |
UploadRtu17ManualRevision
{- "mime_type": "application/pdf",
- "original_file_name": "RTU-17-service-manual-rev-2.pdf",
- "change_note": "Added the revised filter replacement schedule."
}Rtu17ManualRevisionUploadIntent
{- "document_id": "00000000-0000-4000-8000-000000008002",
- "version_id": "00000000-0000-4000-8000-000000008004",
- "upload": {
- "form_fields": {
- "key": "documents/00000000-0000-4000-8000-000000008002/v2",
- "content-type": "application/pdf"
}, - "expires_at": "2026-08-20T09:45:00Z",
- "storage_key": "documents/00000000-0000-4000-8000-000000008002/v2"
}
}Idempotent: re-starring a document is a no-op and returns the same detail response with starred=true. Requires the documents:update grant.
| document_id required | string <uuid> UUID of the document. |
StarredRtu17ServiceManual
{- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "starred": true,
- "preview_available": true,
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Idempotent: un-starring a document that was not starred is a no-op. Returns the document detail with starred=false. Requires the documents:update grant.
| document_id required | string <uuid> UUID of the document. |
UnstarredRtu17ServiceManual
{- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "starred": false,
- "preview_available": true,
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Soft-deletes the document โ the row is moved to the user's Trash and can be restored later. The captured original_path text is recorded so the restore flow can put the document back where it came from. Idempotent. Hard-delete (permanent removal) is DELETE /documents/{document_id} and is only allowed on rows that have already been soft-deleted. Requires the documents:delete grant.
| document_id required | string <uuid> UUID of the document. |
TrashedRtu17ServiceManual
{- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 2,
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "soft_deleted_at": "2026-08-20T10:00:00Z",
- "soft_deleted_by": "00000000-0000-4000-8000-000000000102",
- "original_path": "/Equipment manuals/",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Restores a soft-deleted document from the Trash. The optional request body lets the caller pick the destination and the conflict-resolution strategy. Target folder: when target_folder_id is supplied, the document is restored into that folder (must exist and be user or managed). When omitted, the captured original_path is walked through the live tree and any missing folders are auto-created as user folders so the document reappears at its original location. Conflict resolution (when a live sibling already has the same name): rename uses the supplied new_name for the restored document; new_version appends the restored document's current version as a new version of the existing live sibling and hard-deletes the soft-deleted row (the MIME types must match โ otherwise 422 version-mime-mismatch). When conflict_resolution is omitted and a name collision exists, the call rejects with 409 name-taken. Requires the documents:update grant.
| document_id required | string <uuid> UUID of the document. |
| target_folder_id | string <uuid> Folder to restore into. Omit to use the document's captured |
| conflict_resolution | string Enum: "rename" "new_version" How to handle a name collision in the target folder. Allowed: |
| new_name | string Replacement name. Required when |
RestoreToEquipmentManuals
{- "target_folder_id": "00000000-0000-4000-8000-000000008001"
}RestoredRtu17ServiceManual
{- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Completes the latest pending upload for the given document, populates the version's size and MIME type from the filestore rendition, and points current_version_id at it. Idempotent only when called more than once for the same upload โ for replacing an existing version, use POST /documents/{document_id}/versions/initiate-upload (slice 3b-ii). Requires the documents:create grant.
| document_id required | string <uuid> UUID of the document. |
FinalizedRtu17ServiceManual
{- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Creates a draft document and a draft version, then returns a presigned upload form. The client POSTs the binary content to the form URL, then calls POST /documents/{document_id}/finalize to complete the upload. Until finalize succeeds, the document's current_version_id is null. Requires the documents:create grant.
| name required | string Display name of the document. Validated server-side: NFC-normalized, max 255 codepoints, no path separators / control chars / Windows-reserved characters, not a reserved name. |
| folder_id required | string <uuid> Folder this document will live in. |
| mime_type required | string MIME type of the file being uploaded. |
UploadRtu17ServiceManual
{- "name": "RTU-17 service manual.pdf",
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "mime_type": "application/pdf"
}Rtu17ManualUploadIntent
{- "document_id": "00000000-0000-4000-8000-000000008002",
- "version_id": "00000000-0000-4000-8000-000000008003",
- "upload": {
- "form_fields": {
- "key": "documents/00000000-0000-4000-8000-000000008002/v1",
- "content-type": "application/pdf"
}, - "expires_at": "2026-08-20T08:45:00Z",
- "storage_key": "documents/00000000-0000-4000-8000-000000008002/v1"
}
}Returns the active document-management settings for the calling tenant. Currently the only setting is auto_hard_delete_after_days, which drives the daily auto-hard-delete cron. Requires the documents:read or the documents:settings:update grant, so a settings editor can read the values they edit.
AlpineDocumentRetention
{- "auto_hard_delete_after_days": 45
}JSON merge patch semantics: a field present in the body is applied; an absent field is left unchanged. auto_hard_delete_after_days must be an integer in the inclusive range 1..180. Out-of-range values produce 422 with document-management/invalid-retention-days. Requires the documents:settings:update grant.
| auto_hard_delete_after_days | integer <int32> [ 1 .. 180 ] Number of days after which a soft-deleted document is permanently removed. Must be in the inclusive range 1..180. Field omitted leaves the value unchanged; explicit null is rejected (the field is required and cannot be cleared). |
SetDocumentRetention
{- "auto_hard_delete_after_days": 45
}UpdatedAlpineDocumentRetention
{- "auto_hard_delete_after_days": 45
}Returns the folder with the given id. Requires the documents:read grant.
| folder_id required | string <uuid> UUID of the folder. |
EquipmentManualsFolder
{- "id": "00000000-0000-4000-8000-000000008001",
- "lock_version": 0,
- "name": "Equipment manuals",
- "display_name": "Equipment manuals",
- "kind": "user",
- "created_at": "2026-08-20T08:15:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "starred": true,
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Hard-deletes the folder and any subfolders. Every contained document is soft-deleted as part of the same operation โ its original_path (the human-readable folder path text it lived at) is captured so the user can restore it individually later from the Trash. Folders themselves are NEVER soft-deleted: they are simply removed from the live tree. Managed (managed/managed_branch) folders cannot be deleted directly. Requires the documents:delete grant.
| folder_id required | string <uuid> UUID of the folder. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON merge patch semantics: a field present in the body is applied; an absent field is left unchanged. To move a folder under a new parent, send parent_id as a UUID. To move it to the root, send parent_id: null explicitly. Cycles (moving into self or a descendant) are rejected; descendant paths are rebuilt in the same transaction. Requires the documents:update grant.
| folder_id required | string <uuid> UUID of the folder. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check |
| name | string New folder name. Validation rules: trimmed, NFC-normalized, 1..255 codepoints, no slashes/backslashes/control characters, not a Windows reserved name. Omitted leaves the value unchanged; explicit null is rejected (422) โ name is required and cannot be cleared. |
| parent_id | string or null <uuid> New parent folder id, or null to move to root. Omit to leave the parent unchanged. Cannot move into the folder itself or any of its descendants. Cannot move a managed folder. |
| tag_ids | Array of strings or null <uuid> unique [ items <uuid > ] Replacement set of tag ids. Field omitted leaves tags unchanged; |
RenameAndTagFolder
{- "lock_version": 0,
- "name": "Equipment manuals",
- "tag_ids": [
- "00000000-0000-4000-8000-000000005001"
]
}UpdatedEquipmentManualsFolder
{- "id": "00000000-0000-4000-8000-000000008001",
- "lock_version": 0,
- "name": "Equipment manuals",
- "display_name": "Equipment manuals",
- "kind": "user",
- "created_at": "2026-08-20T08:15:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Returns the document with the given id (soft-deleted documents are returned with soft_deleted_at set). Requires the documents:read grant.
| document_id required | string <uuid> UUID of the document. |
Rtu17ServiceManualDetail
{- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "starred": true,
- "preview_available": true,
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Hard-deletes a soft-deleted document and all its versions. Cannot be called on a live row โ soft-delete it first via POST /documents/{document_id}/soft-delete. Filestore blob cleanup is wired up in a later slice. Requires the documents:delete grant.
| document_id required | string <uuid> UUID of the document. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON merge patch semantics: a field present in the body is applied; an absent field is left unchanged. Send description: null explicitly to clear the description. Send folder_id to move the document into another folder atomically โ the target must be live and have kind = user or kind = managed (managed leaf); managed_branch is rejected. Name collision is checked against the target folder's siblings when a move is requested. Requires the documents:update grant.
| document_id required | string <uuid> UUID of the document. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check |
| name | string New document name. Validation rules match folder names (1..255 codepoints, no slashes/backslashes/control characters, not a Windows reserved name). Omitted leaves the value unchanged; explicit null is rejected (422) โ name is required and cannot be cleared. |
| description | string or null Free-form description. Send null to clear; omit to leave unchanged. |
| folder_id | string <uuid> Move the document into the folder with this id. Target must be live and have |
| tag_ids | Array of strings or null <uuid> unique [ items <uuid > ] Replacement set of tag ids. Field omitted leaves tags unchanged; |
DescribeAndTagRtu17Manual
{- "lock_version": 0,
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "tag_ids": [
- "00000000-0000-4000-8000-000000005001"
]
}UpdatedRtu17ServiceManual
{- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Returns a lightweight usage snapshot for the calling tenant: live and soft-deleted document counts. Available even when the document-management feature flag is off; used by the gated-tenant upgrade page. Usage and quotas live under the generic usage endpoints. Requires the documents:read grant.
AlpineDocumentUsage
{- "document_count": 24,
- "soft_deleted_document_count": 2
}Returns a single mixed list sorted by starred_at desc, paginated. Each entry's kind field is "folder" or "document"; the corresponding folder or document field is populated. Soft-deleted items are excluded โ see GET /soft-deleted for the user's Trash listing. Default page size is 20, capped at 100. Requires the documents:read grant.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
AlpineStarredDocuments
{- "items": [
- {
- "kind": "document",
- "document": {
- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [ ]
}, - "starred_at": "2026-08-20T09:45:00Z"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Returns soft-deleted documents (the user's Trash) sorted by soft_deleted_at desc, paginated. Each entry's kind field is always "document" (folders are never soft-deleted in the new model). The corresponding document field is populated and includes the captured original_path text. Default page size is 20, capped at 100. Tenant-wide and gated by the grant only: a soft-deleted document has no live folder (its folder_id is severed on delete), so per-folder ACL filtering cannot apply here. Requires the documents:read grant.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
AlpineDocumentTrash
{- "items": [
- {
- "kind": "document",
- "document": {
- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 2,
- "name": "RTU-17 service manual.pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "soft_deleted_at": "2026-08-20T10:00:00Z",
- "soft_deleted_by": "00000000-0000-4000-8000-000000000102",
- "original_path": "/Equipment manuals/",
- "access_level": "manage",
- "tags": [ ]
}, - "soft_deleted_at": "2026-08-20T10:00:00Z"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Walks the tree from the root, matching slash-separated name segments (NFC and case-insensitive). Returns 404 if any segment doesn't match a folder. Requires the documents:read grant.
| path required | string Slash-separated display path, e.g. |
EquipmentManualsFolderByPath
{- "id": "00000000-0000-4000-8000-000000008001",
- "lock_version": 0,
- "name": "Equipment manuals",
- "display_name": "Equipment manuals",
- "kind": "user",
- "created_at": "2026-08-20T08:15:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "starred": true,
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}Returns documents directly in the given folder (not the subtree), paginated. Soft-deleted documents are never returned here โ they live under the dedicated /soft-deleted endpoint. Sortable fields: name, createdAt, updatedAt, size. Default sort is name:asc; default page size is 20, capped at 100. Requires the documents:read grant.
| folder_id required | string <uuid> Folder id. |
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
| sort | Array of strings Example: sort=updated_at:desc Repeated sorting criteria in |
EquipmentManualDocuments
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Returns every version, newest first. Pending (not-yet-finalized) versions have finalized_at = null. Requires the documents:read grant.
| document_id required | string <uuid> UUID of the document. |
Rtu17ManualVersions
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000008004",
- "document_id": "00000000-0000-4000-8000-000000008002",
- "version_number": 2,
- "size": 248320,
- "mime_type": "application/pdf",
- "uploaded_by": "00000000-0000-4000-8000-000000000102",
- "uploaded_by_name": "Jonas Leitner",
- "uploaded_at": "2026-08-20T09:30:00Z",
- "finalized_at": "2026-08-20T09:31:00Z",
- "original_file_name": "RTU-17-service-manual-rev-2.pdf",
- "change_note": "Added the revised filter replacement schedule.",
- "preview_available": true
}
]
}Returns up to 50 extractions for the version, newest first. Requires the documents:read grant.
| document_id required | string <uuid> UUID of the document. |
| version_id required | string <uuid> UUID of the document version. |
Rtu17ExtractionHistory
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000008005",
- "document_id": "00000000-0000-4000-8000-000000008002",
- "version_id": "00000000-0000-4000-8000-000000008004",
- "status": "succeeded",
- "created_at": "2026-08-20T09:35:00Z",
- "started_at": "2026-08-20T09:35:02Z",
- "finished_at": "2026-08-20T09:35:08Z",
- "schema": {
- "type": "object",
- "properties": {
- "model": {
- "type": "string"
}, - "filter_replacement_days": {
- "type": "integer"
}
}
}, - "schema_inferred": true,
- "extracted_fields": {
- "model": "RTU-17",
- "filter_replacement_days": 90
}
}
]
}Convenience endpoint: returns the latest extraction whose status is succeeded. Returns 404 (slug extraction-not-found) when no extraction has succeeded yet for this version. Requires the documents:read grant.
| document_id required | string <uuid> UUID of the document. |
| version_id required | string <uuid> UUID of the document version. |
LatestRtu17Extraction
{- "id": "00000000-0000-4000-8000-000000008005",
- "document_id": "00000000-0000-4000-8000-000000008002",
- "version_id": "00000000-0000-4000-8000-000000008004",
- "status": "succeeded",
- "created_at": "2026-08-20T09:35:00Z",
- "started_at": "2026-08-20T09:35:02Z",
- "finished_at": "2026-08-20T09:35:08Z",
- "schema": {
- "type": "object",
- "properties": {
- "model": {
- "type": "string"
}, - "filter_replacement_days": {
- "type": "integer"
}
}
}, - "schema_inferred": true,
- "extracted_fields": {
- "model": "RTU-17",
- "filter_replacement_days": 90
}
}Use GET /api/v2/document-management/documents/{document_id}/versions/{version_id}/download-url. This alias retains identical rendition, download, authorization and expiry behavior for supported native bundles.
| document_id required | string <uuid> UUID of the document. |
| version_id required | string <uuid> UUID of the document version. |
| rendition | string Default: "original" Enum: "original" "preview" Rendition alias to serve. |
| download | boolean Default: false Force attachment download; defaults to safe inline handling. |
DocumentVersionUrl
{- "expires_at": "2026-08-20T10:05:00Z"
}Returns a short-lived presigned URL the client can GET to download the binary content. The URL is signed by the storage backend and expires after a few minutes. The optional rendition query parameter selects which filestore rendition to serve: original (default, the bytes the user uploaded) or preview (a JPEG inline preview, only available for image/PDF uploads when preview_available is true on the version). Set download=true to sign an attachment response with the stored filename. Omitted/false retains safe inline handling; rendition selection is independent of download intent. Requires the documents:read grant.
| document_id required | string <uuid> UUID of the document. |
| version_id required | string <uuid> UUID of the document version. |
| rendition | string Default: "original" Enum: "original" "preview" Rendition alias to serve. Defaults to |
| download | boolean Default: false Force attachment download; defaults to safe inline handling. |
Rtu17ManualDownload
{- "expires_at": "2026-08-20T10:05:00Z"
}Returns finalized, live documents sorted by their current version's uploaded_at descending. With folder_id the result is scoped to that folder's subtree (folder + descendants); without folder_id the listing is tenant-wide. Requires the documents:read grant.
| folder_id | string <uuid> Optional folder scope; when supplied, results are limited to the folder's subtree. |
| limit | integer [ 1 .. 100 ] Default: 25 Maximum number of rows to return. |
| uploaded_after | string <date-time> Strict RFC 3339 cutoff for the current version's |
RecentEquipmentDocuments
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000008002",
- "lock_version": 1,
- "folder_id": "00000000-0000-4000-8000-000000008001",
- "name": "RTU-17 service manual.pdf",
- "description": "Manufacturer service manual for rooftop unit RTU-17.",
- "current_version_id": "00000000-0000-4000-8000-000000008004",
- "size": 248320,
- "mime_type": "application/pdf",
- "created_at": "2026-08-20T08:30:00Z",
- "created_by": "00000000-0000-4000-8000-000000000102",
- "created_by_name": "Jonas Leitner",
- "access_level": "manage",
- "tags": [
- {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "urgent",
- "color": "#D92D20"
}
]
}
]
}Returns the current durable document-management extraction state. Clients use this for an initial load, SSE-triggered refreshes, and polling fallback while an extraction is still running. Requires the documents:read grant.
| extraction_id required | string <uuid> UUID of the document extraction. |
Rtu17Extraction
{- "id": "00000000-0000-4000-8000-000000008005",
- "document_id": "00000000-0000-4000-8000-000000008002",
- "version_id": "00000000-0000-4000-8000-000000008004",
- "status": "succeeded",
- "created_at": "2026-08-20T09:35:00Z",
- "started_at": "2026-08-20T09:35:02Z",
- "finished_at": "2026-08-20T09:35:08Z",
- "schema": {
- "type": "object",
- "properties": {
- "model": {
- "type": "string"
}, - "filter_replacement_days": {
- "type": "integer"
}
}
}, - "schema_inferred": true,
- "extracted_fields": {
- "model": "RTU-17",
- "filter_replacement_days": 90
}
}Durable data requests to a provider connection, the observations they stored and the newest value of each signal.
Newest first, then by id. Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection, including ended ones |
| page | integer <int32> >= 0 Default: 0 |
| size | integer <int32> [ 1 .. 100 ] Default: 20 |
example
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000051",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "contents": [
- "status"
], - "refresh": false,
- "status": "succeeded",
- "requested_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:00:03Z",
- "finished_at": "2023-02-14T10:00:04Z",
- "attempts": 1,
- "observation_ids": [
- "00000000-0000-4000-8000-000000000061"
]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Queues durable work and answers 202 with it; the worker then reads the provider and stores what it delivered as observations, and the operation's status is read at Location. refresh first asks the vehicle for fresh data โ billed by the provider and possibly waking the vehicle โ and is sent at most once. Repeating a request_id with the same content returns the same operation in its current state. Needs vehicles:read and connected-vehicles:data-operations:write, and the connected-vehicles entitlement.
| connection_id required | string <uuid> UUID of the provider connection |
| request_id required | string <uuid> Your key for this request. Repeating it with the same content returns the same operation; with other content it conflicts. |
| contents | Array of strings non-empty unique Items Enum: "status" "diagnostics" Documents to read, each named once. Defaults to the status. |
| refresh | boolean Default: false First ask the vehicle for fresh data. Billed by the provider and it can wake the vehicle; the request then waits before reading again. Only for providers and connections that support it. |
status
{- "request_id": "8d3b6f2e-4a1c-4b7e-9e1f-2c6d8a0b5f14"
}queued
{- "id": "00000000-0000-4000-8000-000000000051",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "contents": [
- "status"
], - "refresh": false,
- "status": "queued",
- "requested_at": "2023-02-14T10:00:00Z",
- "attempts": 0,
- "observation_ids": [ ]
}Newest received first, then by id. Reading never contacts the provider. Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection, including ended ones |
| page | integer <int32> >= 0 Default: 0 |
| size | integer <int32> [ 1 .. 100 ] Default: 20 |
example
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000061",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "data_operation_id": "00000000-0000-4000-8000-000000000051",
- "kind": "status",
- "received_at": "2023-02-14T10:00:04Z",
- "observed_at": "2023-02-14T09:58:41Z",
- "measurements": {
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "observed_at": "2023-02-14T09:58:41Z"
}, - "odometer": {
- "value": 33331,
- "unit": "km",
- "observed_at": "2023-02-14T09:58:41Z"
}
}
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection |
| observation_id required | string <uuid> UUID of the observation |
status
{- "id": "00000000-0000-4000-8000-000000000061",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "data_operation_id": "00000000-0000-4000-8000-000000000051",
- "kind": "status",
- "received_at": "2023-02-14T10:00:04Z",
- "observed_at": "2023-02-14T09:58:41Z",
- "measurements": {
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "observed_at": "2023-02-14T09:58:41Z"
}, - "odometer": {
- "value": 33331,
- "unit": "km",
- "observed_at": "2023-02-14T09:58:41Z"
}
}
}The provider's body verbatim and every exchange, credentials redacted. Needs vehicles:read and connected-vehicles:raw-data:read.
| connection_id required | string <uuid> UUID of the provider connection |
| observation_id required | string <uuid> UUID of the observation |
status
{- "raw_payload": {
- "lat": 48.2082,
- "lon": 16.3738,
- "odometer": 33331000,
- "time": "2023-02-14T09:58:41+00:00"
}, - "exchange_log": [
- {
- "method": "GET",
- "status": 200,
- "duration_ms": 180
}
]
}Across the connection's 100 most recent observations, the value the vehicle measured last for each signal, with the observation it came from. Within them, an answer lacking a signal does not hide an earlier value of it; an undated value shows only when no dated one exists. Never contacts the provider. Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection, including ended ones |
latest
{- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "observed_at": "2023-02-14T09:58:41Z",
- "received_at": "2023-02-14T10:00:04Z",
- "observation_id": "00000000-0000-4000-8000-000000000061"
}, - "fault_codes": {
- "items": [
- {
- "code": "803349"
}
], - "observed_at": "2023-02-13T10:13:02Z",
- "received_at": "2023-02-13T11:00:00Z",
- "observation_id": "00000000-0000-4000-8000-000000000060"
}
}Progress, outcome and the observations it stored. Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection |
| data_operation_id required | string <uuid> UUID of the data request |
succeeded
{- "id": "00000000-0000-4000-8000-000000000051",
- "connection_id": "00000000-0000-4000-8000-000000000012",
- "contents": [
- "status"
], - "refresh": false,
- "status": "succeeded",
- "requested_at": "2023-02-14T10:00:00Z",
- "started_at": "2023-02-14T10:00:03Z",
- "finished_at": "2023-02-14T10:00:04Z",
- "attempts": 1,
- "observation_ids": [
- "00000000-0000-4000-8000-000000000061"
]
}The provider's answer to the last failed attempt and every exchange, credentials redacted. Needs vehicles:read and connected-vehicles:raw-data:read.
| connection_id required | string <uuid> UUID of the provider connection |
| data_operation_id required | string <uuid> UUID of the data request |
refused
{- "raw_payload": {
- "message": "No active consent for this vehicle"
}, - "exchange_log": [
- {
- "method": "GET",
- "status": 403,
- "duration_ms": 212
}
]
}Integration identities that authenticate with a client id and secret (client_credentials) and receive grants from their roles. Managing them requires the 'service-accounts:manage' grant.
Returns the workspace's service accounts, newest first. Regular users are never listed.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Number of items per page (max 100). |
| search | string Case-insensitive substring match on the service account's name. |
ServiceAccounts
{- "items": [
- {
- "id": "0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "name": "Alpine ERP import",
- "description": "Nightly order import from the Alpine ERP",
- "client_id": "tf-sa-0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "roles": [
- "dispatcher"
], - "grants": [
- "tours:read",
- "tours:update"
], - "created_by_user_id": "aaaaaaaa-1111-1111-1111-aaaaaaaaaaaa",
- "created_at": "2026-09-30T08:00:00Z",
- "updated_at": "2026-09-30T08:00:00Z",
- "lock_version": 0,
- "status": "ACTIVE"
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates the account with the given roles and returns its client secret, exactly once. The integration obtains 5-minute access tokens from token_endpoint with the client_credentials grant, authenticating with client_id and client_secret (HTTP Basic). A lost secret can only be rotated.
| name required | string [ 1 .. 255 ] characters Display name, shown as the actor of the account's changes |
| description | string [ 1 .. 1000 ] characters Optional description. Omit it to leave it unset; a blank value is rejected. |
| role_ids required | Array of strings <uuid> non-empty unique [ items <uuid > ] Roles whose grants the account receives; at least one |
CreateErpImport
{- "name": "Alpine ERP import",
- "description": "Nightly order import from the Alpine ERP",
- "role_ids": [
- "4b3c2d1e-9a8b-4c6d-8e0f-1234567890ab"
]
}CreatedServiceAccount
{- "id": "0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "name": "Alpine ERP import",
- "description": "Nightly order import from the Alpine ERP",
- "client_id": "tf-sa-0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "roles": [
- "dispatcher"
], - "grants": [
- "tours:read",
- "tours:update"
], - "created_by_user_id": "aaaaaaaa-1111-1111-1111-aaaaaaaaaaaa",
- "created_at": "2026-09-30T08:00:00Z",
- "updated_at": "2026-09-30T08:00:00Z",
- "lock_version": 0,
- "status": "ACTIVE",
- "client_secret": "example_client_secret_not_a_real_secret"
}Replaces the client secret and returns the new one, exactly once. The previous secret stops working at once, and tokens obtained before the rotation stop working within 30 seconds. The operation takes no request body.
| service_account_id required | string <uuid> Service account id |
RotatedServiceAccountSecret
{- "id": "0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "name": "Alpine ERP import",
- "description": "Nightly order import from the Alpine ERP",
- "client_id": "tf-sa-0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "status": "ACTIVE",
- "roles": [
- "dispatcher"
], - "grants": [
- "tours:read",
- "tours:update"
], - "created_by_user_id": "aaaaaaaa-1111-1111-1111-aaaaaaaaaaaa",
- "created_at": "2026-09-30T08:00:00Z",
- "updated_at": "2027-03-01T09:30:00Z",
- "lock_version": 1,
- "client_secret": "rotated_example_client_secret_not_a_real_secret"
}Stops the integration from obtaining tokens; tokens it already holds stop working within 30 seconds. A service account cannot deactivate itself.
| service_account_id required | string <uuid> Service account id |
DeactivatedServiceAccount
{- "id": "0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "name": "Alpine ERP import",
- "description": "Nightly order import from the Alpine ERP",
- "client_id": "tf-sa-0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "roles": [
- "dispatcher"
], - "grants": [
- "tours:read",
- "tours:update"
], - "created_by_user_id": "aaaaaaaa-1111-1111-1111-aaaaaaaaaaaa",
- "created_at": "2026-09-30T08:00:00Z",
- "updated_at": "2026-09-30T08:00:00Z",
- "lock_version": 0,
- "status": "INACTIVE"
}Lets the integration obtain tokens again.
| service_account_id required | string <uuid> Service account id |
ActivatedServiceAccount
{- "id": "0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "name": "Alpine ERP import",
- "description": "Nightly order import from the Alpine ERP",
- "client_id": "tf-sa-0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "roles": [
- "dispatcher"
], - "grants": [
- "tours:read",
- "tours:update"
], - "created_by_user_id": "aaaaaaaa-1111-1111-1111-aaaaaaaaaaaa",
- "created_at": "2026-09-30T08:00:00Z",
- "updated_at": "2026-09-30T08:00:00Z",
- "lock_version": 0,
- "status": "ACTIVE"
}Returns the service account with its client id, token endpoint, roles and grants. The client secret is never returned.
| service_account_id required | string <uuid> Service account id |
ServiceAccount
{- "id": "0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "name": "Alpine ERP import",
- "description": "Nightly order import from the Alpine ERP",
- "client_id": "tf-sa-0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "roles": [
- "dispatcher"
], - "grants": [
- "tours:read",
- "tours:update"
], - "created_by_user_id": "aaaaaaaa-1111-1111-1111-aaaaaaaaaaaa",
- "created_at": "2026-09-30T08:00:00Z",
- "updated_at": "2026-09-30T08:00:00Z",
- "lock_version": 0,
- "status": "ACTIVE"
}Deletes the account and its client; tokens it already holds stop working within 30 seconds. A service account cannot delete itself.
| service_account_id required | string <uuid> Service account id |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Partially updates the name, description or roles (JSON Merge Patch). The secret changes only through rotate-secret.
| service_account_id required | string <uuid> Service account id |
| name | string [ 1 .. 255 ] characters Display name. Cannot be cleared. |
| description | string or null [ 1 .. 1000 ] characters Description; explicit null clears it, a blank value is rejected. |
| role_ids | Array of strings <uuid> non-empty unique [ items <uuid > ] Replaces the assigned roles; at least one. Explicit null is rejected. |
| lock_version | integer or null <int64> Optimistic locking version; validated when provided (409 on mismatch), omitting it skips the check |
ClearDescription
{- "name": "Alpine ERP order import",
- "description": null
}UpdatedServiceAccount
{- "id": "0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "name": "Alpine ERP order import",
- "client_id": "tf-sa-0192f7a0-3b1c-7d2e-9f40-5a6b7c8d9e0f",
- "status": "ACTIVE",
- "roles": [
- "dispatcher"
], - "grants": [
- "tours:read",
- "tours:update"
], - "created_by_user_id": "aaaaaaaa-1111-1111-1111-aaaaaaaaaaaa",
- "created_at": "2026-09-30T08:00:00Z",
- "updated_at": "2027-03-01T09:30:00Z",
- "lock_version": 1
}Vehicles served through connected-car provider accounts, and their history.
Fixed ordering: started_at descending, then id ascending. By default only active connections are returned. Needs vehicles:read and connected-vehicles:read.
| vehicle_id | string <uuid> Only connections of this Vehicle |
| lifecycle | string Default: "current" Enum: "current" "all" current (default) or all, including ended connections |
| page | integer <int32> >= 0 Default: 0 |
| size | integer <int32> [ 1 .. 100 ] Default: 20 |
example
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000012",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000000031",
- "provider": "DRVN",
- "vin": "WBATA610809M97092",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data",
- "started_at": "2023-02-14T10:00:00Z",
- "is_location_source": false,
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Binds the Vehicle's current VIN, which must be set, to an enabled workspace provider account. Connecting does not contact the provider. Repeating an active connection returns it with 200. The same account serving the VIN on another Vehicle, or this Vehicle with another brand or data source, conflicts. While the connection is active the Vehicle's VIN cannot change. Needs vehicles:update and connected-vehicles:create, and the connected-vehicles entitlement.
| vehicle_id required | string <uuid> |
| provider_account_id required | string <uuid> Enabled workspace provider account that serves the Vehicle. |
| brand | string [ 0 .. 64 ] characters Brand as the provider names it, e.g. |
| data_source | string [ 0 .. 128 ] characters DRVN product for this Vehicle, as letters, digits, '.', '_' or '-', including a letter or digit; the account's default applies when omitted. Only DRVN connections have one. A blank string is rejected. |
drvn
{- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000000031",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data"
}active
{- "id": "00000000-0000-4000-8000-000000000012",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000000031",
- "provider": "DRVN",
- "vin": "WBATA610809M97092",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data",
- "started_at": "2023-02-14T10:00:00Z",
- "is_location_source": false,
- "lock_version": 0
}Ends the connection immediately, releases it as location source and queues the revocation of its upstream access; the authorization's revocation_status follows it. History and the Vehicle's last-known position are kept. Repeating end changes nothing. Needs vehicles:update and connected-vehicles:delete.
| connection_id required | string <uuid> UUID of the provider connection, including ended ones |
ended
{- "id": "00000000-0000-4000-8000-000000000012",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000000031",
- "provider": "DRVN",
- "vin": "WBATA610809M97092",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data",
- "started_at": "2023-02-14T10:00:00Z",
- "ended_at": "2023-02-14T11:00:00Z",
- "is_location_source": false,
- "lock_version": 1
}Ended connections remain addressable. Needs vehicles:read and connected-vehicles:read.
| connection_id required | string <uuid> UUID of the provider connection, including ended ones |
active
{- "id": "00000000-0000-4000-8000-000000000012",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000000031",
- "provider": "DRVN",
- "vin": "WBATA610809M97092",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data",
- "started_at": "2023-02-14T10:00:00Z",
- "is_location_source": false,
- "lock_version": 0
}Selecting makes the connection the Vehicle's location source in place of any device association and adopts the newest position it already delivered; it never asks the provider. Fixes it delivers later move the Vehicle when they are newer. Releasing leaves the Vehicle without a source and keeps its last-known position. Only an active connection can be selected, and not while a plugin's operational Device supplies the location. Every source change advances lock_version of the connections and Device associations it selects or displaces. Needs vehicles:update and connected-vehicles:update.
| connection_id required | string <uuid> UUID of the provider connection |
| is_location_source | boolean Select this connection as the Vehicle's location source, or release it. Selecting adopts the newest position it already delivered and never asks the provider. |
| lock_version | integer or null <int64> >= 0 Optional version precondition; a stale version returns 409. |
select
{- "is_location_source": true,
- "lock_version": 0
}selected
{- "id": "00000000-0000-4000-8000-000000000012",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000000031",
- "provider": "DRVN",
- "vin": "WBATA610809M97092",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data",
- "started_at": "2023-02-14T10:00:00Z",
- "is_location_source": true,
- "lock_version": 1
}Returns a paginated list of areas. Requires the 'areas:read' grant.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Example: size=20 Number of items per page (max 100). |
ServiceAreasPage
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000002001",
- "name": "Vienna North",
- "description": "Alpine Facility Services coverage north of the Danube",
- "color": "#1570EF",
- "geo_json": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 16.35,
- 48.24
], - [
- 16.48,
- 48.24
], - [
- 16.48,
- 48.32
], - [
- 16.35,
- 48.32
], - [
- 16.35,
- 48.24
]
]
]
}, - "zip_ranges": [
- {
- "country": "AUT",
- "from": "1210",
- "to": "1220"
}
], - "created_at": "2026-08-20T08:30:00Z",
- "updated_at": "2026-08-20T08:30:00Z",
- "lock_version": 0
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Requires the 'areas:create' grant.
| name required | string [ 1 .. 32 ] characters Non-blank display name of the area; empty or whitespace-only values are rejected. |
| description | string <= 255 characters Optional description |
| color | string Hex color used to render the area overlay on maps |
| geo_json required | any GeoJSON Feature / FeatureCollection containing exactly one Polygon or MultiPolygon |
Array of objects (ZipRange) Optional postal-code ranges that fall inside this area |
CreateViennaNorthArea
{- "name": "Vienna North",
- "description": "Alpine Facility Services coverage north of the Danube",
- "color": "#1570EF",
- "geo_json": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 16.35,
- 48.24
], - [
- 16.48,
- 48.24
], - [
- 16.48,
- 48.32
], - [
- 16.35,
- 48.32
], - [
- 16.35,
- 48.24
]
]
]
}, - "zip_ranges": [
- {
- "country": "AUT",
- "from": "1210",
- "to": "1220"
}
]
}CreatedViennaNorthArea
{- "id": "00000000-0000-4000-8000-000000002001",
- "name": "Vienna North",
- "description": "Alpine Facility Services coverage north of the Danube",
- "color": "#1570EF",
- "geo_json": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 16.35,
- 48.24
], - [
- 16.48,
- 48.24
], - [
- 16.48,
- 48.32
], - [
- 16.35,
- 48.32
], - [
- 16.35,
- 48.24
]
]
]
}, - "zip_ranges": [
- {
- "country": "AUT",
- "from": "1210",
- "to": "1220"
}
], - "created_at": "2026-08-20T08:30:00Z",
- "updated_at": "2026-08-20T08:30:00Z",
- "lock_version": 0
}Requires the 'areas:read' grant.
| area_id required | string <uuid> UUID of the area. |
ViennaNorthArea
{- "id": "00000000-0000-4000-8000-000000002001",
- "name": "Vienna North",
- "description": "Alpine Facility Services coverage north of the Danube",
- "color": "#1570EF",
- "geo_json": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 16.35,
- 48.24
], - [
- 16.48,
- 48.24
], - [
- 16.48,
- 48.32
], - [
- 16.35,
- 48.32
], - [
- 16.35,
- 48.24
]
]
]
}, - "zip_ranges": [
- {
- "country": "AUT",
- "from": "1210",
- "to": "1220"
}
], - "created_at": "2026-08-20T08:30:00Z",
- "updated_at": "2026-08-20T08:30:00Z",
- "lock_version": 0
}Requires the 'areas:delete' grant.
| area_id required | string <uuid> UUID of the area. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON Merge Patch (RFC 7386): omitted fields remain unchanged; a field set to null is cleared (description and color). Requires the 'areas:update' grant.
| area_id required | string <uuid> UUID of the area. |
| name | string [ 1 .. 32 ] characters Display name of the area. Omitted leaves the value unchanged. Explicit null is rejected (422) โ name is required and cannot be cleared. |
| description | string or null <= 255 characters Optional description. Omitted leaves the value unchanged; explicit null clears it. |
| color | string or null Hex color used to render the area overlay on maps. Omitted leaves the value unchanged; explicit null clears it. |
| geo_json | any GeoJSON Feature / FeatureCollection containing exactly one Polygon or MultiPolygon. Omitted or null leaves the value unchanged. |
Array of objects or null (ZipRange) Optional postal-code ranges that fall inside this area. Omitted or null leaves the value unchanged; a provided list replaces the stored ranges. | |
| lock_version | integer or null <int64> Optimistic lock version returned by the previous read |
RenameViennaNorthArea
{- "name": "Vienna North Operations",
- "lock_version": 0
}UpdatedViennaNorthArea
{- "id": "00000000-0000-4000-8000-000000002001",
- "name": "Vienna North Operations",
- "description": "Alpine Facility Services coverage north of the Danube",
- "color": "#1570EF",
- "geo_json": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 16.35,
- 48.24
], - [
- 16.48,
- 48.24
], - [
- 16.48,
- 48.32
], - [
- 16.35,
- 48.32
], - [
- 16.35,
- 48.24
]
]
]
}, - "zip_ranges": [
- {
- "country": "AUT",
- "from": "1210",
- "to": "1220"
}
], - "created_at": "2026-08-20T08:30:00Z",
- "updated_at": "2026-08-20T09:30:00Z",
- "lock_version": 1
}Returns a paginated list of brands.
| page | integer >= 0 Default: 0 Page number (0-based). |
| size | integer [ 1 .. 100 ] Default: 20 Number of items per page (max 100). |
| sort | Array of strings Example: sort=name:asc Repeated sorting criteria in |
| search | string Search term for brand name, email, or phone number. |
BrandsListResponse
{- "items": [
- {
- "id": "00000000-0000-4000-8000-000000000801",
- "created_at": "2026-08-20T08:10:00Z",
- "updated_at": "2026-08-20T08:10:00Z",
- "lock_version": 0,
- "name": "Alpine Facility Services GmbH",
- "email": "dispatch@example.invalid",
- "phone_number": "+43123456789",
- "linked_custom_domains": [ ]
}
], - "page": {
- "size": 20,
- "total_elements": 1,
- "total_pages": 1,
- "number": 0
}
}Creates a brand. Logo updates should use the presigned upload intent endpoints under /api/v2/brands/{brand_id}/logo/uploads.
| name required | string [ 0 .. 255 ] characters Brand name |
string <email> [ 0 .. 255 ] characters Brand contact email | |
| phone_number | string [ 0 .. 255 ] characters International contact number. An explicit '+' country code is required; common formatting is accepted and normalized to canonical E.164. National numbers are rejected. |
| theme_id | string <uuid> Optional custom theme linked to this brand |
CreateBrandRequest
{- "name": "Alpine Facility Services GmbH",
- "email": "dispatch@example.invalid",
- "phone_number": "+43 1 234 56 789"
}CreateBrandResponse
{- "id": "00000000-0000-4000-8000-000000000801",
- "created_at": "2026-08-20T08:10:00Z",
- "updated_at": "2026-08-20T08:10:00Z",
- "lock_version": 0,
- "name": "Alpine Facility Services GmbH",
- "email": "dispatch@example.invalid",
- "phone_number": "+43123456789",
- "linked_custom_domains": [ ]
}Creates a presigned upload URL for brand logo uploads (PNG/JPEG only).
| brand_id required | string <uuid> UUID of the brand. |
| original_file_name required | string non-empty Original filename for the brand logo upload. |
| mime_type required | string non-empty ^[iI][mM][aA][gG][eE]/([pP][nN][gG]|[jJ][pP][... MIME type of the brand logo upload (image/png or image/jpeg). |
CreateBrandLogoUpload
{- "original_file_name": "alpine-brand-logo.png",
- "mime_type": "image/png"
}AlpineBrandLogoUpload
{- "file_id": "00000000-0000-4000-8000-000000000811",
- "upload_fields": {
- "key": "alpine/brand-logo.png",
- "policy": "example-not-a-real-policy"
}, - "upload_url_expires_at": "2026-08-20T10:20:00Z"
}Creates a presigned upload URL for brand favicon uploads (PNG only).
| brand_id required | string <uuid> UUID of the brand. |
| original_file_name required | string non-empty Original filename for the brand favicon upload. |
| mime_type required | string non-empty ^[iI][mM][aA][gG][eE]/[pP][nN][gG]$ MIME type of the brand favicon upload (image/png only). |
CreateBrandFaviconUpload
{- "original_file_name": "alpine-brand-favicon.png",
- "mime_type": "image/png"
}AlpineBrandFaviconUpload
{- "file_id": "00000000-0000-4000-8000-000000000812",
- "upload_fields": {
- "key": "alpine/brand-favicon.png",
- "policy": "example-not-a-real-policy"
}, - "upload_url_expires_at": "2026-08-20T10:20:00Z"
}Idempotent: re-linking the same pair is a no-op. Returns 422 if the domain is not in VERIFIED status, or 409 if it is already linked to a different brand.
| brand_id required | string <uuid> UUID of the brand. |
| custom_domain_id required | string <uuid> UUID of the custom-domain link. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Idempotent: unlinking a pair that is not linked returns 204. The custom domain row itself is untouched.
| brand_id required | string <uuid> UUID of the brand. |
| custom_domain_id required | string <uuid> UUID of the custom-domain link. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Returns one brand by its UUID.
| brand_id required | string <uuid> UUID of the brand. |
BrandResponse
{- "id": "00000000-0000-4000-8000-000000000801",
- "created_at": "2026-08-20T08:10:00Z",
- "updated_at": "2026-08-20T08:10:00Z",
- "lock_version": 0,
- "name": "Alpine Facility Services GmbH",
- "email": "dispatch@example.invalid",
- "phone_number": "+43123456789",
- "linked_custom_domains": [ ]
}Permanently removes the brand and its linked branding assets.
| brand_id required | string <uuid> UUID of the brand. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}JSON Merge Patch (RFC 7386). Fields omitted remain unchanged; fields set to null are cleared (for nullable fields).
| brand_id required | string <uuid> UUID of the brand. |
| lock_version | integer or null <int64> Optimistic-locking version: validated when provided (409 on mismatch); omitting it skips the concurrency check |
| name | string Brand name. Omitted leaves the value unchanged. Explicit null is rejected (422) โ name is required and cannot be cleared. |
string or null Brand contact email. Omitted leaves the value unchanged; explicit null clears it. | |
| phone_number | string or null International contact number. An explicit '+' country code is required; common formatting is accepted and normalized to canonical E.164. National numbers are rejected. Omitted leaves the value unchanged; explicit null clears it. |
| theme_id | string or null <uuid> Optional custom theme linked to this brand. Omitted leaves the value unchanged; explicit null clears it. |
UpdateBrandNull
{- "lock_version": 2,
- "email": null,
- "phone_number": "+43 1 234 56 789"
}BrandResponse
{- "id": "00000000-0000-4000-8000-000000000801",
- "created_at": "2026-08-20T08:10:00Z",
- "updated_at": "2026-08-20T08:10:00Z",
- "lock_version": 0,
- "name": "Alpine Facility Services GmbH",
- "email": "dispatch@example.invalid",
- "phone_number": "+43123456789",
- "linked_custom_domains": [ ]
}Removes the current brand logo.
| brand_id required | string <uuid> UUID of the brand. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Returns upload lifecycle status for a brand logo upload session.
| brand_id required | string <uuid> UUID of the brand. |
| file_id required | string <uuid> UUID of the uploaded file. |
UploadedAlpineBrandLogo
{- "file_id": "00000000-0000-4000-8000-000000000811",
- "status": "UPLOADED",
- "logo_applied": true,
}Removes the current brand favicon.
| brand_id required | string <uuid> UUID of the brand. |
{- "title": "Validation failed",
- "status": 422,
- "detail": "One or more fields failed validation",
- "instance": "string",
- "errors": [
- {
- "type": "string",
- "title": "string",
- "detail": "string",
- "pointer": "#/driver/email",
- "data": {
- "property1": null,
- "property2": null
}
}
], - "data": {
- "property1": null,
- "property2": null
}
}Returns upload lifecycle status for a brand favicon upload session.
| brand_id required | string <uuid> UUID of the brand. |
| file_id required | string <uuid> UUID of the uploaded file. |
UploadedAlpineBrandFavicon
{- "file_id": "00000000-0000-4000-8000-000000000812",
- "status": "UPLOADED",
- "favicon_applied": true,
}Returns the default country and default focus point used by geocoding flows.
ViennaGeocodingSettings
{- "default_country": "AT",
- "default_focus_point": {
- "lat": 48.2082,
- "lon": 16.3738
}, - "map": {
- "default_zoom": 13,
- "overview_zoom": 10,
- "default_style": "STREETS"
}
}JSON Merge Patch (RFC 7386). Omitted fields remain unchanged; null resets a field to the default value. Inside map, omitted sub-fields also remain unchanged, so a patch may name a single zoom level. The whole patch is applied atomically: if any field fails validation, none is stored.
| default_country | string or null Default country as ISO 3166-1 alpha-2 code. Omit to leave unchanged; null resets to the default (DE). |
GeocodingFocusPoint (object) or null Default focus point used to bias forward geocoding results. Omit to leave unchanged; null resets to the default (Berlin). | |
UpdateGeocodingMapDefaults (object) or null Map defaults. Omit to leave unchanged; include only the sub-fields you want to change; null resets the whole block to the defaults (zoom 11, overview zoom 5.5, STREETS). |
UpdateDefaultCountryOnly
{- "default_country": "AT"
}UpdatedViennaGeocodingSettings
{- "default_country": "AT",
- "default_focus_point": {
- "lat": 48.2082,
- "lon": 16.3738
}, - "map": {
- "default_zoom": 13,
- "overview_zoom": 10,
- "default_style": "STREETS"
}
}Delivered when tag is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tag.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TagCreatedEventData) Resource and previous values carried by TagCreatedEvent. |
{- "type": "tag.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Maintenance",
- "color": "#2563EB"
}
}
}Delivered when tag is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tag.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TagUpdatedEventData) Resource and previous values carried by TagUpdatedEvent. |
{- "type": "tag.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Maintenance",
- "color": "#2563EB"
}
}
}Delivered when tag is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tag.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TagDeletedEventData) Resource and previous values carried by TagDeletedEvent. |
{- "type": "tag.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when sms gateway is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "sms_gateway.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (SmsGatewayCreatedEventData) Resource and previous values carried by SmsGatewayCreatedEvent. |
{- "type": "sms_gateway.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Technician notifications",
- "type": "TWILIO",
- "enabled": true,
- "priority": 1
}
}
}Delivered when sms gateway is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "sms_gateway.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (SmsGatewayUpdatedEventData) Resource and previous values carried by SmsGatewayUpdatedEvent. |
{- "type": "sms_gateway.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Technician notifications",
- "type": "TWILIO",
- "enabled": true,
- "priority": 1
}
}
}Delivered when sms gateway is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "sms_gateway.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (SmsGatewayDeletedEventData) Resource and previous values carried by SmsGatewayDeletedEvent. |
{- "type": "sms_gateway.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when task definition is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "task_definition.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TaskDefinitionDeletedEventData) Resource and previous values carried by TaskDefinitionDeletedEvent. |
{- "type": "task_definition.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when task definition is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "task_definition.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TaskDefinitionCreatedEventData) Resource and previous values carried by TaskDefinitionCreatedEvent. |
{- "type": "task_definition.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "natural_id_key": "INS",
- "icon": "clipboard-check",
- "color": "teal",
- "map_marker_fields": [
- "title"
], - "execution_type": "simple",
- "is_extendable": false,
- "managed_by": {
- "type": "tenant"
}, - "schema_policy": "editable",
- "attributes": [ ],
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when task definition is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "task_definition.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TaskDefinitionUpdatedEventData) Resource and previous values carried by TaskDefinitionUpdatedEvent. |
{- "type": "task_definition.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "21d3f004-0000-4000-8000-000000000001",
- "slug": "inspection",
- "name": {
- "en": {
- "singular": "Inspection",
- "plural": "Inspections"
}
}, - "natural_id_key": "INS",
- "icon": "clipboard-check",
- "color": "teal",
- "map_marker_fields": [
- "title"
], - "execution_type": "simple",
- "is_extendable": false,
- "managed_by": {
- "type": "tenant"
}, - "schema_policy": "editable",
- "attributes": [ ],
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T10:00:00Z",
- "lock_version": 1
}, - "previous_attributes": {
- "name": {
- "en": {
- "singular": "Site inspection",
- "plural": "Site inspections"
}
}, - "lock_version": 0,
- "updated_at": "2026-09-24T09:00:00Z"
}
}
}Delivered when task is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "task.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TaskCreatedEventData) Resource and previous values carried by TaskCreatedEvent. |
{- "type": "task.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "definition_id": "46600000-0000-4000-8000-000000000001",
- "data": { },
- "id": "00000000-0000-4000-8000-000000003001",
- "title": "Replace the RTU-17 air filter",
- "status": "open",
- "type": "simple",
- "natural_id": 1042,
- "assignee_user_id": "00000000-0000-4000-8000-000000000101",
- "linked_records": [ ],
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when task is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "task.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TaskUpdatedEventData) Resource and previous values carried by TaskUpdatedEvent. |
{- "type": "task.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "definition_id": "46600000-0000-4000-8000-000000000001",
- "data": { },
- "id": "00000000-0000-4000-8000-000000003001",
- "title": "Replace the RTU-17 air filter",
- "status": "open",
- "type": "simple",
- "natural_id": 1042,
- "assignee_user_id": "00000000-0000-4000-8000-000000000101",
- "linked_records": [ ],
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T10:00:00Z",
- "lock_version": 1
}, - "previous_attributes": {
- "title": "Inspect the air filter",
- "lock_version": 0,
- "updated_at": "2026-09-24T09:00:00Z"
}
}
}Delivered when task is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "task.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TaskDeletedEventData) Resource and previous values carried by TaskDeletedEvent. |
{- "type": "task.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when tour settings is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_settings.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourSettingsUpdatedEventData) Resource and previous values carried by TourSettingsUpdatedEvent. |
{- "type": "tour_settings.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-0000-0000-000000000000",
- "excluded_vehicle_definition_ids": [ ],
- "lock_version": 1
}
}
}Delivered when tour stop is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour.stop.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourStopCreatedEventData) Resource and previous values carried by TourStopCreatedEvent. |
{- "type": "tour.stop.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "type": "standalone",
- "id": "00000000-0000-4000-8000-000000001001",
- "tour_id": "00000000-0000-4000-8000-000000002001",
- "position": 0,
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "address_label": "Vienna service centre",
- "street": "Stephansplatz 1",
- "city": "Vienna",
- "postal_code": "1010",
- "country_code": "AT"
}, - "status": "open",
- "task_ids": [ ],
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour stop is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour.stop.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourStopUpdatedEventData) Resource and previous values carried by TourStopUpdatedEvent. |
{- "type": "tour.stop.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "type": "standalone",
- "id": "00000000-0000-4000-8000-000000001001",
- "tour_id": "00000000-0000-4000-8000-000000002001",
- "position": 0,
- "location": {
- "lat": 48.2082,
- "lon": 16.3738,
- "address_label": "Vienna service centre",
- "street": "Stephansplatz 1",
- "city": "Vienna",
- "postal_code": "1010",
- "country_code": "AT"
}, - "status": "open",
- "task_ids": [ ],
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour stop is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour.stop.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourStopDeletedEventData) Resource and previous values carried by TourStopDeletedEvent. |
{- "type": "tour.stop.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when tour task assignment is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_task_assignment.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourTaskAssignmentCreatedEventData) Resource and previous values carried by TourTaskAssignmentCreatedEvent. |
{- "type": "tour_task_assignment.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "tour_id": "00000000-0000-4000-8000-000000002001",
- "tour_natural_id": 204,
- "task_id": "00000000-0000-4000-8000-000000003001",
- "position": 0,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour task assignment is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_task_assignment.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourTaskAssignmentUpdatedEventData) Resource and previous values carried by TourTaskAssignmentUpdatedEvent. |
{- "type": "tour_task_assignment.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "tour_id": "00000000-0000-4000-8000-000000002001",
- "tour_natural_id": 204,
- "task_id": "00000000-0000-4000-8000-000000003001",
- "position": 0,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour task assignment is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_task_assignment.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourTaskAssignmentDeletedEventData) Resource and previous values carried by TourTaskAssignmentDeletedEvent. |
{- "type": "tour_task_assignment.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when tour template is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_template.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourTemplateCreatedEventData) Resource and previous values carried by TourTemplateCreatedEvent. |
{- "type": "tour_template.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "is_default": false,
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Weekly ventilation maintenance",
- "timezone": "Europe/Vienna",
- "required_skill_ids": [ ],
- "task_count": 2,
- "stop_count": 1,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour template is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_template.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourTemplateUpdatedEventData) Resource and previous values carried by TourTemplateUpdatedEvent. |
{- "type": "tour_template.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "is_default": false,
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Weekly ventilation maintenance",
- "timezone": "Europe/Vienna",
- "required_skill_ids": [ ],
- "task_count": 2,
- "stop_count": 1,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T10:00:00Z",
- "lock_version": 1
}, - "previous_attributes": {
- "name": "Weekly ventilation maintenance (draft)",
- "lock_version": 0,
- "updated_at": "2026-09-24T09:00:00Z"
}
}
}Delivered when tour template is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_template.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourTemplateDeletedEventData) Resource and previous values carried by TourTemplateDeletedEvent. |
{- "type": "tour_template.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when tour vehicle assignment is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_vehicle_assignment.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourVehicleAssignmentCreatedEventData) Resource and previous values carried by TourVehicleAssignmentCreatedEvent. |
{- "type": "tour_vehicle_assignment.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001071",
- "tour_id": "00000000-0000-4000-8000-000000001070",
- "vehicle_id": "00000000-0000-4000-8000-000000001072",
- "role": "Delivery",
- "assigned_at": "2026-09-24T09:00:00Z",
- "assigned_by_user_id": "00000000-0000-4000-8000-000000000101",
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour vehicle assignment is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_vehicle_assignment.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourVehicleAssignmentUpdatedEventData) Resource and previous values carried by TourVehicleAssignmentUpdatedEvent. |
{- "type": "tour_vehicle_assignment.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001071",
- "tour_id": "00000000-0000-4000-8000-000000001070",
- "vehicle_id": "00000000-0000-4000-8000-000000001072",
- "role": "Delivery",
- "assigned_at": "2026-09-24T09:00:00Z",
- "assigned_by_user_id": "00000000-0000-4000-8000-000000000101",
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour vehicle assignment is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour_vehicle_assignment.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourVehicleAssignmentDeletedEventData) Resource and previous values carried by TourVehicleAssignmentDeletedEvent. |
{- "type": "tour_vehicle_assignment.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001071",
- "tour_id": "00000000-0000-4000-8000-000000001070",
- "vehicle_id": "00000000-0000-4000-8000-000000001072",
- "role": "Delivery",
- "assigned_at": "2026-09-24T09:00:00Z",
- "assigned_by_user_id": "00000000-0000-4000-8000-000000000101",
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when tour is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourCreatedEventData) Resource and previous values carried by TourCreatedEvent. |
{- "type": "tour.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000002001",
- "description": "Vienna morning maintenance",
- "origin": "planned",
- "natural_id": 204,
- "participant_user_ids": [
- "00000000-0000-4000-8000-000000000101"
], - "publication_status": "draft",
- "execution_status": "not_started",
- "created_by_user_id": "00000000-0000-4000-8000-000000000101",
- "required_skill_ids": [ ],
- "task_count": 0,
- "stop_count": 0,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0,
- "vehicles": [ ]
}
}
}Delivered when tour is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourUpdatedEventData) Resource and previous values carried by TourUpdatedEvent. |
{- "type": "tour.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000002001",
- "description": "Vienna morning maintenance",
- "origin": "planned",
- "natural_id": 204,
- "participant_user_ids": [
- "00000000-0000-4000-8000-000000000101"
], - "publication_status": "draft",
- "execution_status": "not_started",
- "created_by_user_id": "00000000-0000-4000-8000-000000000101",
- "required_skill_ids": [ ],
- "task_count": 0,
- "stop_count": 0,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0,
- "vehicles": [ ]
}
}
}Delivered when tour is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "tour.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (TourDeletedEventData) Resource and previous values carried by TourDeletedEvent. |
{- "type": "tour.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when brand is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "brand.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (BrandCreatedEventData) Resource and previous values carried by BrandCreatedEvent. |
{- "type": "brand.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Alpine Facility Services",
- "email": "contact@alpine-facility-services.example.invalid",
- "phone_number": "+4312345678"
}
}
}Delivered when brand is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "brand.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (BrandUpdatedEventData) Resource and previous values carried by BrandUpdatedEvent. |
{- "type": "brand.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Alpine Facility Services",
- "email": "contact@alpine-facility-services.example.invalid",
- "phone_number": "+4312345678"
}
}
}Delivered when brand is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "brand.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (BrandDeletedEventData) Resource and previous values carried by BrandDeletedEvent. |
{- "type": "brand.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when skill is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "skill.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (SkillCreatedEventData) Resource and previous values carried by SkillCreatedEvent. |
{- "type": "skill.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Ventilation maintenance",
- "short_key": "HV",
- "managed_by": "tenant"
}
}
}Delivered when skill is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "skill.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (SkillUpdatedEventData) Resource and previous values carried by SkillUpdatedEvent. |
{- "type": "skill.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Ventilation maintenance",
- "short_key": "HV",
- "managed_by": "tenant"
}
}
}Delivered when skill is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "skill.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (SkillDeletedEventData) Resource and previous values carried by SkillDeletedEvent. |
{- "type": "skill.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when area is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "area.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (AreaCreatedEventData) Resource and previous values carried by AreaCreatedEvent. |
{- "type": "area.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Vienna Centre",
- "description": "Maintenance coverage for central Vienna",
- "color": "#2563EB"
}
}
}Delivered when area is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "area.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (AreaUpdatedEventData) Resource and previous values carried by AreaUpdatedEvent. |
{- "type": "area.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Vienna Centre",
- "description": "Maintenance coverage for central Vienna",
- "color": "#2563EB"
}
}
}Delivered when area is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "area.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (AreaDeletedEventData) Resource and previous values carried by AreaDeletedEvent. |
{- "type": "area.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when measure unit is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "measure_unit.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (MeasureUnitCreatedEventData) Resource and previous values carried by MeasureUnitCreatedEvent. |
{- "type": "measure_unit.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Hour",
- "symbol": "h"
}
}
}Delivered when measure unit is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "measure_unit.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (MeasureUnitUpdatedEventData) Resource and previous values carried by MeasureUnitUpdatedEvent. |
{- "type": "measure_unit.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Hour",
- "symbol": "h"
}
}
}Delivered when measure unit is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "measure_unit.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (MeasureUnitDeletedEventData) Resource and previous values carried by MeasureUnitDeletedEvent. |
{- "type": "measure_unit.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when role is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "role.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (RoleUpdatedEventData) Resource and previous values carried by RoleUpdatedEvent. |
{- "type": "role.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Dispatcher",
- "grants_added": [
- "tasks:write"
], - "grants_removed": [ ]
}
}
}Delivered when user is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "user.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (UserCreatedEventData) Resource and previous values carried by UserCreatedEvent. |
{- "type": "user.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000000101",
- "email": "jonas.leitner@example.invalid",
- "active": true,
- "first_name": "Jonas",
- "last_name": "Leitner",
- "profile_status": "COMPLETE",
- "phone_number": "+436641234567",
- "role_associations": [ ]
}
}
}Delivered when user is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "user.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (UserUpdatedEventData) Resource and previous values carried by UserUpdatedEvent. |
{- "type": "user.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000000101",
- "email": "jonas.leitner@example.invalid",
- "active": true,
- "first_name": "Jonas",
- "last_name": "Leitner",
- "profile_status": "COMPLETE",
- "phone_number": "+436641234567",
- "role_associations": [ ]
}
}
}Delivered when user is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "user.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (UserDeletedEventData) Resource and previous values carried by UserDeletedEvent. |
{- "type": "user.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when theme is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "theme.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ThemeCreatedEventData) Resource and previous values carried by ThemeCreatedEvent. |
{- "type": "theme.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Alpine blue",
- "active": true
}
}
}Delivered when theme is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "theme.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ThemeUpdatedEventData) Resource and previous values carried by ThemeUpdatedEvent. |
{- "type": "theme.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "Alpine blue",
- "active": true
}
}
}Delivered when theme is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "theme.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ThemeDeletedEventData) Resource and previous values carried by ThemeDeletedEvent. |
{- "type": "theme.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when file is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "file.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (FileCreatedEventData) Resource and previous values carried by FileCreatedEvent. |
{- "type": "file.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "description": "Completed air-filter inspection",
- "is_public": false
}
}
}Delivered when file is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "file.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (FileUpdatedEventData) Resource and previous values carried by FileUpdatedEvent. |
{- "type": "file.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "description": "Completed air-filter inspection",
- "is_public": false
}
}
}Delivered when file is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "file.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (FileDeletedEventData) Resource and previous values carried by FileDeletedEvent. |
{- "type": "file.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when document is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "document.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DocumentCreatedEventData) Resource and previous values carried by DocumentCreatedEvent. |
{- "type": "document.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "state": "ACTIVE",
- "name": "inspection-report.pdf",
- "size": 24576,
- "folder_id": "00000000-0000-4000-8000-000000005001",
- "version_id": "00000000-0000-4000-8000-000000005002",
- "version_number": 1,
- "mime_type": "application/pdf",
- "created_by": "00000000-0000-4000-8000-000000000101"
}
}
}Delivered when document is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "document.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DocumentUpdatedEventData) Resource and previous values carried by DocumentUpdatedEvent. |
{- "type": "document.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "state": "ACTIVE",
- "name": "inspection-report.pdf",
- "size": 24576,
- "folder_id": "00000000-0000-4000-8000-000000005001",
- "version_id": "00000000-0000-4000-8000-000000005002",
- "version_number": 1,
- "mime_type": "application/pdf",
- "created_by": "00000000-0000-4000-8000-000000000101"
}
}
}Delivered when document is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "document.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DocumentDeletedEventData) Resource and previous values carried by DocumentDeletedEvent. |
{- "type": "document.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "state": "TRASHED",
- "name": "inspection-report.pdf",
- "size": 24576,
- "version_id": "00000000-0000-4000-8000-000000005002",
- "version_number": 1,
- "mime_type": "application/pdf",
- "created_by": "00000000-0000-4000-8000-000000000101",
- "original_path": "/Maintenance/inspection-report.pdf"
}
}
}Delivered when document version is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "document.version.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DocumentVersionCreatedEventData) Resource and previous values carried by DocumentVersionCreatedEvent. |
{- "type": "document.version.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000005002",
- "document_id": "00000000-0000-4000-8000-000000001001",
- "folder_id": "00000000-0000-4000-8000-000000005001",
- "version_number": 1,
- "size": 24576,
- "mime_type": "application/pdf",
- "change_note": "Initial inspection report"
}
}
}Delivered when document permissions is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "document.permissions.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DocumentPermissionsUpdatedEventData) Resource and previous values carried by DocumentPermissionsUpdatedEvent. |
{- "type": "document.permissions.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "added_count": 1,
- "changed_count": 0,
- "removed_count": 0
}
}
}Delivered when folder is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "folder.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (FolderCreatedEventData) Resource and previous values carried by FolderCreatedEvent. |
{- "type": "folder.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "Maintenance",
- "kind": "user",
- "created_by": "00000000-0000-4000-8000-000000000101"
}
}
}Delivered when folder is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "folder.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (FolderUpdatedEventData) Resource and previous values carried by FolderUpdatedEvent. |
{- "type": "folder.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000005001",
- "name": "Maintenance",
- "kind": "user",
- "created_by": "00000000-0000-4000-8000-000000000101"
}
}
}Delivered when folder is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "folder.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (FolderDeletedEventData) Resource and previous values carried by FolderDeletedEvent. |
{- "type": "folder.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when folder permissions is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "folder.permissions.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (FolderPermissionsUpdatedEventData) Resource and previous values carried by FolderPermissionsUpdatedEvent. |
{- "type": "folder.permissions.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000005001",
- "added_count": 1,
- "changed_count": 0,
- "removed_count": 0
}
}
}Delivered when comment is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "comment.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (CommentCreatedEventData) Resource and previous values carried by CommentCreatedEvent. |
{- "type": "comment.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "state": "ACTIVE",
- "author_id": "00000000-0000-4000-8000-000000000101",
- "target_type": "object:equipment",
- "target_id": "00000000-0000-4000-8000-000000006001",
- "body_markdown": "The RTU-17 air filter has been replaced.",
- "mentions": [ ],
- "attachments": [ ],
- "is_moderation": false
}
}
}Delivered when comment is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "comment.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (CommentUpdatedEventData) Resource and previous values carried by CommentUpdatedEvent. |
{- "type": "comment.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "state": "ACTIVE",
- "author_id": "00000000-0000-4000-8000-000000000101",
- "target_type": "object:equipment",
- "target_id": "00000000-0000-4000-8000-000000006001",
- "body_markdown": "The RTU-17 air filter has been replaced.",
- "mentions": [ ],
- "attachments": [ ],
- "is_moderation": false
}
}
}Delivered when comment reaction is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "comment.reaction.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (CommentReactionCreatedEventData) Resource and previous values carried by CommentReactionCreatedEvent. |
{- "type": "comment.reaction.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "emoji": "๐",
- "comment_id": "00000000-0000-4000-8000-000000001001",
- "comment_author_id": "00000000-0000-4000-8000-000000000102",
- "target_type": "object:equipment",
- "target_id": "00000000-0000-4000-8000-000000006001"
}
}
}Delivered when comment reaction is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "comment.reaction.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (CommentReactionDeletedEventData) Resource and previous values carried by CommentReactionDeletedEvent. |
{- "type": "comment.reaction.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "emoji": "๐",
- "comment_id": "00000000-0000-4000-8000-000000001001",
- "comment_author_id": "00000000-0000-4000-8000-000000000102",
- "target_type": "object:equipment",
- "target_id": "00000000-0000-4000-8000-000000006001"
}
}
}Delivered when record is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent. The example segment stands for the object's actual definition slug.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string^object\.[^.]+\.created$ Event name with the actual object definition slug; example is illustrative only. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ObjectRecordCreatedEventData) Resource and previous values carried by ObjectRecordCreatedEvent. |
{- "type": "object.example.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000006001",
- "object_id": "00000000-0000-4000-8000-000000006002",
- "object_slug": "example",
- "data": {
- "name": "RTU-17",
- "serial_number": "AFS-RTU-0017"
}
}
}
}Delivered when record is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent. The example segment stands for the object's actual definition slug.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string^object\.[^.]+\.updated$ Event name with the actual object definition slug; example is illustrative only. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ObjectRecordUpdatedEventData) Resource and previous values carried by ObjectRecordUpdatedEvent. |
{- "type": "object.example.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000006001",
- "object_id": "00000000-0000-4000-8000-000000006002",
- "object_slug": "example",
- "data": {
- "name": "RTU-17",
- "serial_number": "AFS-RTU-0017"
}
}
}
}Delivered when record is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent. The example segment stands for the object's actual definition slug.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string^object\.[^.]+\.deleted$ Event name with the actual object definition slug; example is illustrative only. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ObjectRecordDeletedEventData) Resource and previous values carried by ObjectRecordDeletedEvent. |
{- "type": "object.example.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000006001",
- "object_id": "00000000-0000-4000-8000-000000006002",
- "object_slug": "example",
- "data": {
- "name": "RTU-17",
- "serial_number": "AFS-RTU-0017"
}
}
}
}Delivered when object permissions is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent. The example segment stands for the object's actual definition slug.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string^object\.[^.]+\.permissions\.updated$ Event name with the actual object definition slug; example is illustrative only. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ObjectRecordPermissionsUpdatedEventData) Resource and previous values carried by ObjectRecordPermissionsUpdatedEvent. |
{- "type": "object.example.permissions.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000006001",
- "object_slug": "example",
- "added_count": 1,
- "changed_count": 0,
- "removed_count": 0
}
}
}Delivered when object definition is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "object_definition.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ObjectDefinitionCreatedEventData) Resource and previous values carried by ObjectDefinitionCreatedEvent. |
{- "type": "object_definition.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000006002",
- "slug": "equipment"
}
}
}Delivered when object definition is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "object_definition.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ObjectDefinitionUpdatedEventData) Resource and previous values carried by ObjectDefinitionUpdatedEvent. |
{- "type": "object_definition.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000006002",
- "slug": "equipment"
}
}
}Delivered when object definition is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "object_definition.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ObjectDefinitionDeletedEventData) Resource and previous values carried by ObjectDefinitionDeletedEvent. |
{- "type": "object_definition.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000006002",
- "slug": "equipment"
}
}
}Delivered when device is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "device.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DeviceCreatedEventData) Resource and previous values carried by DeviceCreatedEvent. |
{- "type": "device.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "platform": "ANDROID",
- "description": "Jonas's service phone",
- "phone_number": "+436641234567",
- "provisioning_state": "PROVISIONED",
- "enrolled": true
}
}
}Delivered when device is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "device.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DeviceUpdatedEventData) Resource and previous values carried by DeviceUpdatedEvent. |
{- "type": "device.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "platform": "ANDROID",
- "description": "Jonas's service phone",
- "phone_number": "+436641234567",
- "provisioning_state": "PROVISIONED",
- "enrolled": true
}
}
}Delivered when device is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "device.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DeviceDeletedEventData) Resource and previous values carried by DeviceDeletedEvent. |
{- "type": "device.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when workspace device settings is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "device_settings.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (DeviceSettingsUpdatedEventData) Resource and previous values carried by DeviceSettingsUpdatedEvent. |
{- "type": "device_settings.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "admin_managed_devices": false,
- "app_location_tracking_policy": "during_work",
- "lock_version": 1
}
}
}Delivered when vehicle definition is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_definition.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleDefinitionDeletedEventData) Resource and previous values carried by VehicleDefinitionDeletedEvent. |
{- "type": "vehicle_definition.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when vehicle definition is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_definition.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleDefinitionCreatedEventData) Resource and previous values carried by VehicleDefinitionCreatedEvent. |
{- "type": "vehicle_definition.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when vehicle definition is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_definition.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleDefinitionUpdatedEventData) Resource and previous values carried by VehicleDefinitionUpdatedEvent. |
{- "type": "vehicle_definition.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when vehicleโdevice association is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_device_association.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleDeviceAssociationCreatedEventData) Resource and previous values carried by VehicleDeviceAssociationCreatedEvent. |
{- "type": "vehicle_device_association.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000000011",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "started_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "association_mode": "fixed",
- "is_location_source": true,
- "is_preferred_fixed_source": true
}
}
}Delivered when vehicleโdevice association is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_device_association.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleDeviceAssociationUpdatedEventData) Resource and previous values carried by VehicleDeviceAssociationUpdatedEvent. |
{- "type": "vehicle_device_association.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000000011",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "device_id": "00000000-0000-4000-8000-000000000002",
- "started_at": "2023-02-14T10:00:00Z",
- "lock_version": 0,
- "association_mode": "fixed",
- "is_location_source": true,
- "is_preferred_fixed_source": true
}
}
}Delivered when vehicle location source is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle.location_source.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleLocationSourceUpdatedEventData) Resource and previous values carried by VehicleLocationSourceUpdatedEvent. |
{- "type": "vehicle.location_source.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000000001",
- "association_id": "00000000-0000-4000-8000-000000000011",
- "source_kind": "fixed_device",
- "effective_at": "2026-09-24T10:00:00Z"
}, - "previous_attributes": {
- "association_id": null
}
}
}Delivered when vehicle is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleDeletedEventData) Resource and previous values carried by VehicleDeletedEvent. |
{- "type": "vehicle.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when vehicle is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleCreatedEventData) Resource and previous values carried by VehicleCreatedEvent. |
{- "type": "vehicle.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when vehicle is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleUpdatedEventData) Resource and previous values carried by VehicleUpdatedEvent. |
{- "type": "vehicle.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when connected-vehicle provider account is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "connected_vehicle_provider.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ConnectedVehicleProviderCreatedEventData) Resource and previous values carried by ConnectedVehicleProviderCreatedEvent. |
{- "type": "connected_vehicle_provider.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "DRVN UAT",
- "provider": "DRVN",
- "environment": "UAT",
- "enabled": true
}
}
}Delivered when connected-vehicle provider account is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "connected_vehicle_provider.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ConnectedVehicleProviderUpdatedEventData) Resource and previous values carried by ConnectedVehicleProviderUpdatedEvent. |
{- "type": "connected_vehicle_provider.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001",
- "name": "DRVN UAT",
- "provider": "DRVN",
- "environment": "UAT",
- "enabled": true
}
}
}Delivered when connected-vehicle provider account is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "connected_vehicle_provider.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (ConnectedVehicleProviderDeletedEventData) Resource and previous values carried by ConnectedVehicleProviderDeletedEvent. |
{- "type": "connected_vehicle_provider.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when vehicle provider connection data operation is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_provider_connection.data_operation.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleProviderConnectionDataOperationCreatedEventData) Resource and previous values carried by VehicleProviderConnectionDataOperationCreatedEvent. |
{- "type": "vehicle_provider_connection.data_operation.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001051",
- "connection_id": "00000000-0000-4000-8000-000000001012",
- "contents": [
- "status"
], - "refresh": false,
- "status": "succeeded",
- "requested_at": "2026-01-15T09:30:00Z",
- "finished_at": "2026-01-15T09:30:04Z",
- "attempts": 1
}
}
}Delivered when vehicle provider connection data operation is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_provider_connection.data_operation.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleProviderConnectionDataOperationUpdatedEventData) Resource and previous values carried by VehicleProviderConnectionDataOperationUpdatedEvent. |
{- "type": "vehicle_provider_connection.data_operation.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001051",
- "connection_id": "00000000-0000-4000-8000-000000001012",
- "contents": [
- "status"
], - "refresh": false,
- "status": "succeeded",
- "requested_at": "2026-01-15T09:30:00Z",
- "finished_at": "2026-01-15T09:30:04Z",
- "attempts": 1
}
}
}Delivered when vehicle provider connection phone-fix prediction is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_provider_connection.phone_fix_prediction.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleProviderConnectionPhoneFixPredictionCreatedEventData) Resource and previous values carried by VehicleProviderConnectionPhoneFixPredictionCreatedEvent. |
{- "type": "vehicle_provider_connection.phone_fix_prediction.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001071",
- "connection_id": "00000000-0000-4000-8000-000000001012",
- "symptom": "wont_start",
- "status": "succeeded",
- "requested_at": "2026-01-15T09:40:00Z",
- "finished_at": "2026-01-15T09:40:03Z",
- "attempts": 1,
- "probability": 0.019,
- "baseline_probability": 0.018
}
}
}Delivered when vehicle provider connection phone-fix prediction is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_provider_connection.phone_fix_prediction.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleProviderConnectionPhoneFixPredictionUpdatedEventData) Resource and previous values carried by VehicleProviderConnectionPhoneFixPredictionUpdatedEvent. |
{- "type": "vehicle_provider_connection.phone_fix_prediction.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001071",
- "connection_id": "00000000-0000-4000-8000-000000001012",
- "symptom": "wont_start",
- "status": "succeeded",
- "requested_at": "2026-01-15T09:40:00Z",
- "finished_at": "2026-01-15T09:40:03Z",
- "attempts": 1,
- "probability": 0.019,
- "baseline_probability": 0.018
}
}
}Delivered when vehicle provider connection is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_provider_connection.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleProviderConnectionCreatedEventData) Resource and previous values carried by VehicleProviderConnectionCreatedEvent. |
{- "type": "vehicle_provider_connection.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001012",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000001001",
- "provider": "DRVN",
- "vin": "WBATA610809M97092",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data",
- "started_at": "2026-01-15T09:00:00Z",
- "is_location_source": true,
- "lock_version": 1
}
}
}Delivered when vehicle provider connection is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "vehicle_provider_connection.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (VehicleProviderConnectionUpdatedEventData) Resource and previous values carried by VehicleProviderConnectionUpdatedEvent. |
{- "type": "vehicle_provider_connection.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001012",
- "vehicle_id": "00000000-0000-4000-8000-000000000001",
- "provider_account_id": "00000000-0000-4000-8000-000000001001",
- "provider": "DRVN",
- "vin": "WBATA610809M97092",
- "brand": "bmw",
- "data_source": "bmw_b2c_reactive_car_data",
- "started_at": "2026-01-15T09:00:00Z",
- "is_location_source": true,
- "lock_version": 1
}
}
}Delivered when workflow is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "workflow.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (WorkflowCreatedEventData) Resource and previous values carried by WorkflowCreatedEvent. |
{- "type": "workflow.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000004001",
- "name": "Inspect new equipment",
- "is_enabled": true,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when workflow is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "workflow.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (WorkflowUpdatedEventData) Resource and previous values carried by WorkflowUpdatedEvent. |
{- "type": "workflow.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000004001",
- "name": "Inspect new equipment",
- "is_enabled": true,
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T10:00:00Z",
- "lock_version": 1
}, - "previous_attributes": {
- "name": "Inspect new equipment (draft)",
- "lock_version": 0,
- "updated_at": "2026-09-24T09:00:00Z"
}
}
}Delivered when workflow is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "workflow.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (WorkflowDeletedEventData) Resource and previous values carried by WorkflowDeletedEvent. |
{- "type": "workflow.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}Delivered when workflow version is created. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "workflow.version.created" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (WorkflowVersionCreatedEventData) Resource and previous values carried by WorkflowVersionCreatedEvent. |
{- "type": "workflow.version.created",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000004002",
- "workflow_id": "00000000-0000-4000-8000-000000004001",
- "name": "Inspect new equipment",
- "state": "draft",
- "version_number": 1,
- "created_by": "00000000-0000-4000-8000-000000000101",
- "updated_by": "00000000-0000-4000-8000-000000000101",
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T09:00:00Z",
- "lock_version": 0
}
}
}Delivered when workflow version is updated. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "workflow.version.updated" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (WorkflowVersionUpdatedEventData) Resource and previous values carried by WorkflowVersionUpdatedEvent. |
{- "type": "workflow.version.updated",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000004002",
- "workflow_id": "00000000-0000-4000-8000-000000004001",
- "name": "Inspect new equipment",
- "state": "draft",
- "version_number": 1,
- "created_by": "00000000-0000-4000-8000-000000000101",
- "updated_by": "00000000-0000-4000-8000-000000000101",
- "created_at": "2026-09-24T09:00:00Z",
- "updated_at": "2026-09-24T10:00:00Z",
- "lock_version": 1
}, - "previous_attributes": {
- "name": "Inspect new equipment (draft)",
- "lock_version": 0,
- "updated_at": "2026-09-24T09:00:00Z"
}
}
}Delivered when workflow version is deleted. Verify the Standard Webhooks signature against the raw request body; no bearer token is sent.
| webhook-id required | string <uuid> Unique message id (UUID). Stable across retries of the same event โ use it as an idempotency key. |
| webhook-timestamp required | string^[0-9]+$ Example: 1787565600 Unix timestamp in seconds at which this delivery attempt was signed. Reject deliveries outside your tolerance window. |
| webhook-signature required | string Example: v1,dGVzdC1zaWduYXR1cmU= Standard Webhooks signature: |
| type required | string Value: "workflow.version.deleted" Event name identifying this delivery. |
| id required | string <uuid> Delivery id, identical to the |
| event_id required | string <uuid> Id of the underlying event. Identical across every endpoint and every retry that delivers it โ use it to deduplicate when more than one endpoint feeds one consumer. |
| timestamp required | string <date-time> When the event occurred (ISO 8601, UTC). Not the time this attempt was signed โ that is the |
| payload_version required | integer <int32> [ 1 .. 1 ] Webhook payload contract version. |
| tenant_id required | string <uuid> Workspace the event belongs to. |
object (WebhookActor) The principal that caused the event. | |
object (WebhookRequestContext) Tracing handles for the API request that caused this event. | |
required | object (WorkflowVersionDeletedEventData) Resource and previous values carried by WorkflowVersionDeletedEvent. |
{- "type": "workflow.version.deleted",
- "id": "00000000-0000-4000-8000-000000009001",
- "event_id": "00000000-0000-4000-8000-000000009002",
- "timestamp": "2026-09-24T10:00:00Z",
- "payload_version": 1,
- "tenant_id": "00000000-0000-4000-8000-000000000001",
- "actor": {
- "type": "USER",
- "id": "00000000-0000-4000-8000-000000000101"
}, - "request": {
- "id": "maintenance-webhook-example"
}, - "data": {
- "object": {
- "id": "00000000-0000-4000-8000-000000001001"
}
}
}