> ## Documentation Index > Fetch the complete documentation index at: https://seam-feat-mintlify-migration-iteration.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get an Event > Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](/developer-tools/webhooks), but it enables you to retrieve an event that already took place. ## OpenAPI ````yaml /openapi.json post /events/get openapi: 3.0.0 info: title: Seam Connect version: 1.0.0 servers: - url: https://connect.getseam.com security: [] tags: - description: access_codes name: /access_codes - description: acs name: /acs - description: action_attempts name: /action_attempts - description: client_sessions name: /client_sessions - description: connected_accounts name: /connected_accounts - description: connect_webviews name: /connect_webviews - description: devices name: /devices - description: events name: /events - description: health name: /health - description: locks name: /locks - description: networks name: /networks - description: noise_sensors name: /noise_sensors - description: phones name: /phones - description: thermostats name: /thermostats - description: user_identities name: /user_identities - description: webhooks name: /webhooks - description: workspaces name: /workspaces paths: /events/get: post: tags: - /events summary: Get an Event description: >- Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](/developer-tools/webhooks), but it enables you to retrieve an event that already took place. operationId: eventsGetPost requestBody: content: application/json: schema: properties: device_id: description: >- Unique identifier for the device that triggered the event that you want to get. format: uuid type: string event_id: description: Unique identifier for the event that you want to get. format: uuid type: string event_type: description: Type of the event that you want to get. type: string type: object responses: '200': content: application/json: schema: properties: event: $ref: '#/components/schemas/event' message: type: string ok: type: boolean required: - ok type: object description: OK '400': description: Bad Request '401': description: Unauthorized security: - client_session: [] - api_key: [] - pat_with_workspace: [] - console_session_with_workspace: [] - client_session_with_customer: [] x-codeSamples: - lang: javascript label: Seam SDK source: >- await seam.events.get({ event_id: "ed3adbb8-bbe1-4033-a35a-710d44322bd8" }); /* { "connected_account_id": "2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b", "created_at": "2025-06-15T16:54:18.000000Z", "device_id": "3febfdb2-de92-43c1-aba4-640ce8a55a22", "event_description": "The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.", "event_id": "ed3adbb8-bbe1-4033-a35a-710d44322bd8", "event_type": "device.connected", "occurred_at": "2025-06-15T16:54:17.946329Z", "workspace_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d" } */ - lang: bash label: cURL source: >- curl --include --request POST "https://connect.getseam.com/events/get" \ --header "Authorization: Bearer $SEAM_API_KEY" \ --json @- < { "connected_account_id" => "2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b", "created_at" => "2025-06-15T16:54:18.000000Z", "device_id" => "3febfdb2-de92-43c1-aba4-640ce8a55a22", "event_description" => "The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.", "event_id" => "ed3adbb8-bbe1-4033-a35a-710d44322bd8", "event_type" => "device.connected", "occurred_at" => "2025-06-15T16:54:17.946329Z", "workspace_id" => "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d", } - lang: php label: Seam SDK source: >- $seam->events->get(event_id: "ed3adbb8-bbe1-4033-a35a-710d44322bd8"); // [ "connected_account_id" => "2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b", "created_at" => "2025-06-15T16:54:18.000000Z", "device_id" => "3febfdb2-de92-43c1-aba4-640ce8a55a22", "event_description" => "The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.", "event_id" => "ed3adbb8-bbe1-4033-a35a-710d44322bd8", "event_type" => "device.connected", "occurred_at" => "2025-06-15T16:54:17.946329Z", "workspace_id" => "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d", ]; - lang: bash label: Seam CLI source: >- seam events get --event_id "ed3adbb8-bbe1-4033-a35a-710d44322bd8" # { # "connected_account_id": "2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b", # "created_at": "2025-06-15T16:54:18.000000Z", # "device_id": "3febfdb2-de92-43c1-aba4-640ce8a55a22", # "event_description": "The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.", # "event_id": "ed3adbb8-bbe1-4033-a35a-710d44322bd8", # "event_type": "device.connected", # "occurred_at": "2025-06-15T16:54:17.946329Z", # "workspace_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d" # } components: schemas: event: description: >- Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event. discriminator: propertyName: event_type oneOf: - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was created. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.created type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was changed. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.changed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was [scheduled natively](/low-level-apis/smart-locks/access-codes#native-scheduling) on a device. properties: access_code_id: description: ID of the affected access code. format: uuid type: string code: description: Code for the affected access code. type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.scheduled_on_device type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - code type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was set on a device. properties: access_code_id: description: ID of the affected access code. format: uuid type: string code: description: Code for the affected access code. type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.set_on_device type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - code type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was removed from a device. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.removed_from_device type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes - description: >- There was an unusually long delay in setting an [access code](/low-level-apis/smart-locks/access-codes) on a device. properties: access_code_errors: description: Errors associated with the access code. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array access_code_id: description: ID of the affected access code. format: uuid type: string access_code_warnings: description: Warnings associated with the access code. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the device associated with the affected access code. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.delay_in_setting_on_device type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings - access_code_errors - access_code_warnings type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) failed to be set on a device. properties: access_code_errors: description: Errors associated with the access code. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array access_code_id: description: ID of the affected access code. format: uuid type: string access_code_warnings: description: Warnings associated with the access code. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the device associated with the affected access code. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.failed_to_set_on_device type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings - access_code_errors - access_code_warnings type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was deleted. properties: access_code_id: description: ID of the affected access code. format: uuid type: string code: description: Code for the affected access code. nullable: true type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - code type: object x-route-path: /access_codes - description: >- There was an unusually long delay in removing an [access code](/low-level-apis/smart-locks/access-codes) from a device. properties: access_code_errors: description: Errors associated with the access code. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array access_code_id: description: ID of the affected access code. format: uuid type: string access_code_warnings: description: Warnings associated with the access code. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the device associated with the affected access code. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.delay_in_removing_from_device type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings - access_code_errors - access_code_warnings type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) failed to be removed from a device. properties: access_code_errors: description: Errors associated with the access code. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array access_code_id: description: ID of the affected access code. format: uuid type: string access_code_warnings: description: Warnings associated with the access code. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the device associated with the affected access code. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.failed_to_remove_from_device type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings - access_code_errors - access_code_warnings type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was modified outside of Seam. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.modified_external_to_seam type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes - description: >- An [access code](/low-level-apis/smart-locks/access-codes) was deleted outside of Seam. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.deleted_external_to_seam type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes - description: >- A [backup access code](/low-level-apis/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. properties: access_code_id: description: ID of the affected access code. format: uuid type: string backup_access_code_id: type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.backup_access_code_pulled type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - backup_access_code_id type: object x-route-path: /access_codes - description: >- An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.unmanaged.converted_to_managed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes/unmanaged - description: >- An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. properties: access_code_errors: description: Errors associated with the access code. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array access_code_id: description: ID of the affected access code. format: uuid type: string access_code_warnings: description: Warnings associated with the access code. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the device associated with the affected access code. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.unmanaged.failed_to_convert_to_managed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings - access_code_errors - access_code_warnings type: object x-route-path: /access_codes/unmanaged - description: >- An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.unmanaged.created type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes/unmanaged - description: >- An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. properties: access_code_id: description: ID of the affected access code. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the affected access code. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the device associated with the affected access code. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_code.unmanaged.removed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_code_id - device_id - connected_account_id - event_type type: object x-route-path: /access_codes/unmanaged - description: An Access Grant was created. properties: access_grant_id: description: ID of the affected Access Grant. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_grant.created type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_grant_id - event_type type: object x-route-path: /access_grants - description: An Access Grant was deleted. properties: access_grant_id: description: ID of the affected Access Grant. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_grant.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_grant_id - event_type type: object x-route-path: /access_grants - description: All access requested for an Access Grant was successfully granted. properties: access_grant_id: description: ID of the affected Access Grant. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_grant.access_granted_to_all_doors type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_grant_id - event_type type: object x-route-path: /access_grants - description: >- Access requested as part of an Access Grant to a particular door was successfully granted. properties: access_grant_id: description: ID of the affected Access Grant. format: uuid type: string acs_entrance_id: description: >- ID of the affected [entrance](/low-level-apis/access-systems/retrieving-entrance-details). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_grant.access_granted_to_door type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_grant_id - event_type - acs_entrance_id type: object x-route-path: /access_grants - description: >- Access to a particular door that was requested as part of an Access Grant was lost. properties: access_grant_id: description: ID of the affected Access Grant. format: uuid type: string acs_entrance_id: description: >- ID of the affected [entrance](/low-level-apis/access-systems/retrieving-entrance-details). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_grant.access_to_door_lost type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_grant_id - event_type - acs_entrance_id type: object x-route-path: /access_grants - description: An Access Grant's start or end time was changed. properties: access_grant_id: description: ID of the affected Access Grant. format: uuid type: string access_grant_key: description: Key of the affected Access Grant (if present). type: string created_at: description: Date and time at which the event was created. format: date-time type: string ends_at: description: The new end time for the access grant. type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_grant.access_times_changed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string starts_at: description: The new start time for the access grant. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_grant_id - event_type type: object x-route-path: /access_grants - description: >- One or more requested access methods could not be created for an Access Grant. properties: access_grant_id: description: ID of the affected Access Grant. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string error_message: description: Description of why the access methods could not be created. type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_grant.could_not_create_requested_access_methods type: string missing_device_ids: description: >- IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant. items: format: uuid type: string type: array occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_grant_id - event_type - error_message type: object x-route-path: /access_grants - description: An access method was issued. properties: access_grant_ids: description: IDs of the access grants associated with this access method. items: format: uuid type: string type: array access_grant_keys: description: >- Keys of the access grants associated with this access method (if present). items: type: string type: array access_method_id: description: ID of the affected access method. format: uuid type: string code: description: >- The actual PIN code for code access methods (only present when mode is 'code'). type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_method.issued type: string is_backup_code: description: >- Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). type: boolean occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_method_id - access_grant_ids - event_type type: object x-route-path: /access_methods - description: An access method was revoked. properties: access_grant_ids: description: IDs of the access grants associated with this access method. items: format: uuid type: string type: array access_grant_keys: description: >- Keys of the access grants associated with this access method (if present). items: type: string type: array access_method_id: description: ID of the affected access method. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_method.revoked type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_method_id - access_grant_ids - event_type type: object x-route-path: /access_methods - description: An access method representing a physical card requires encoding. properties: access_grant_ids: description: IDs of the access grants associated with this access method. items: format: uuid type: string type: array access_grant_keys: description: >- Keys of the access grants associated with this access method (if present). items: type: string type: array access_method_id: description: ID of the affected access method. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_method.card_encoding_required type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_method_id - access_grant_ids - event_type type: object x-route-path: /access_methods - description: An access method was deleted. properties: access_grant_ids: description: IDs of the access grants associated with this access method. items: format: uuid type: string type: array access_grant_keys: description: >- Keys of the access grants associated with this access method (if present). items: type: string type: array access_method_id: description: ID of the affected access method. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_method.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_method_id - access_grant_ids - event_type type: object x-route-path: /access_methods - description: An access method was reissued. properties: access_grant_ids: description: IDs of the access grants associated with this access method. items: format: uuid type: string type: array access_grant_keys: description: >- Keys of the access grants associated with this access method (if present). items: type: string type: array access_method_id: description: ID of the affected access method. format: uuid type: string code: description: >- The actual PIN code for code access methods (only present when mode is 'code'). type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_method.reissued type: string is_backup_code: description: >- Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). type: boolean occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_method_id - access_grant_ids - event_type type: object x-route-path: /access_methods - description: An access method was created. properties: access_grant_ids: description: IDs of the access grants associated with this access method. items: format: uuid type: string type: array access_grant_keys: description: >- Keys of the access grants associated with this access method (if present). items: type: string type: array access_method_id: description: ID of the affected access method. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - access_method.created type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - access_method_id - access_grant_ids - event_type type: object x-route-path: /access_methods - description: An [access system](/low-level-apis/access-systems) was connected. properties: acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_system.connected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - event_type type: object x-route-path: /acs/systems - description: An [access system](/low-level-apis/access-systems) was added. properties: acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_system.added type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - event_type type: object x-route-path: /acs/systems - description: An [access system](/low-level-apis/access-systems) was disconnected. properties: acs_system_errors: description: Errors associated with the access control system. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array acs_system_id: description: ID of the access system. format: uuid type: string acs_system_warnings: description: Warnings associated with the access control system. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: ID of the connected account. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_system.disconnected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - event_type - acs_system_errors - acs_system_warnings - connected_account_errors - connected_account_warnings type: object x-route-path: /acs/systems - description: >- An [access system credential](/low-level-apis/access-systems/managing-credentials) was deleted. properties: acs_credential_id: description: ID of the affected credential. format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_credential.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_credential_id - event_type type: object x-route-path: /acs/credentials - description: >- An [access system credential](/low-level-apis/access-systems/managing-credentials) was issued. properties: acs_credential_id: description: ID of the affected credential. format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_credential.issued type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_credential_id - event_type type: object x-route-path: /acs/credentials - description: >- An [access system credential](/low-level-apis/access-systems/managing-credentials) was reissued. properties: acs_credential_id: description: ID of the affected credential. format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_credential.reissued type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_credential_id - event_type type: object x-route-path: /acs/credentials - description: >- An [access system credential](/low-level-apis/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore. properties: acs_credential_id: description: ID of the affected credential. format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_credential.invalidated type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_credential_id - event_type type: object x-route-path: /acs/credentials - description: >- An [access system user](/low-level-apis/access-systems/user-management) was created. properties: acs_system_id: description: ID of the access system. format: uuid type: string acs_user_id: format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_user.created type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_user_id - event_type type: object x-route-path: /acs/users - description: >- An [access system user](/low-level-apis/access-systems/user-management) was deleted. properties: acs_system_id: description: ID of the access system. format: uuid type: string acs_user_id: format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_user.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_user_id - event_type type: object x-route-path: /acs/users - description: >- An [access system encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was added. properties: acs_encoder_id: description: ID of the affected encoder. format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_encoder.added type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_encoder_id - event_type type: object x-route-path: /acs/encoders - description: >- An [access system encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was removed. properties: acs_encoder_id: description: ID of the affected encoder. format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_encoder.removed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_encoder_id - event_type type: object x-route-path: /acs/encoders - description: An ACS access group was deleted. properties: acs_access_group_id: description: ID of the affected access group. format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_access_group.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_access_group_id - event_type type: object x-route-path: /acs/access_groups - description: >- An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details) was added. properties: acs_entrance_id: format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_entrance.added type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_entrance_id - event_type type: object x-route-path: /acs/entrances - description: >- An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details) was removed. properties: acs_entrance_id: format: uuid type: string acs_system_id: description: ID of the access system. format: uuid type: string connected_account_id: description: ID of the connected account. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - acs_entrance.removed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - acs_system_id - acs_entrance_id - event_type type: object x-route-path: /acs/entrances - description: >- A [client session](/core-concepts/authentication/client-session-tokens) was deleted. properties: client_session_id: description: ID of the affected client session. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - client_session.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - client_session_id - event_type type: object x-route-path: /client_sessions - description: >- A [connected account](/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected. properties: connect_webview_id: description: >- ID of the [Connect Webview](/core-concepts/connect-webviews) associated with the event. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with this connected account, if any. type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.connected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type type: object x-route-path: /connected_accounts - description: >- A [connected account](/core-concepts/connected-accounts) was created. properties: connect_webview_id: description: >- ID of the [Connect Webview](/core-concepts/connect-webviews) associated with the event. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.created type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type - connect_webview_id type: object x-route-path: /connected_accounts - deprecated: true description: >- A [connected account](/core-concepts/connected-accounts) had a successful login using a [Connect Webview](/core-concepts/connect-webviews). properties: connect_webview_id: description: >- ID of the [Connect Webview](/core-concepts/connect-webviews) associated with the event. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.successful_login type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type - connect_webview_id type: object x-deprecated: Use `connect_webview.login_succeeded`. x-route-path: /connected_accounts - description: >- A [connected account](/core-concepts/connected-accounts) was disconnected. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.disconnected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type - connected_account_errors - connected_account_warnings type: object x-route-path: /connected_accounts - description: >- A [connected account](/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.completed_first_sync type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type type: object x-route-path: /connected_accounts - description: >- A [connected account](/core-concepts/connected-accounts) was deleted. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string connected_account_type: description: 'undocumented: Unreleased.' type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with this connected account, if any. type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type type: object x-route-path: /connected_accounts - description: >- A [connected account](/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.completed_first_sync_after_reconnection type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type type: object x-route-path: /connected_accounts - description: >- A [connected account](/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the affected [connected account](/core-concepts/connected-accounts). format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connected_account.reauthorization_requested type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type - connected_account_errors - connected_account_warnings type: object x-route-path: /connected_accounts - description: >- A lock door [action attempt](/core-concepts/action-attempts) succeeded. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.lock_door.succeeded type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: A lock door [action attempt](/core-concepts/action-attempts) failed. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.lock_door.failed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: >- An unlock door [action attempt](/core-concepts/action-attempts) succeeded. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.unlock_door.succeeded type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: >- An unlock door [action attempt](/core-concepts/action-attempts) failed. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.unlock_door.failed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: >- A simulate keypad code entry [action attempt](/core-concepts/action-attempts) succeeded. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.simulate_keypad_code_entry.succeeded type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: >- A simulate keypad code entry [action attempt](/core-concepts/action-attempts) failed. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.simulate_keypad_code_entry.failed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: >- A simulate manual lock via keypad [action attempt](/core-concepts/action-attempts) succeeded. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.simulate_manual_lock_via_keypad.succeeded type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: >- A simulate manual lock via keypad [action attempt](/core-concepts/action-attempts) failed. properties: action_attempt_id: description: ID of the affected action attempt. format: uuid type: string action_type: description: Type of the action. type: string connected_account_id: description: >- ID of the connected account associated with the action attempt, if applicable. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string device_id: description: >- ID of the device associated with the action attempt, if applicable. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - action_attempt.simulate_manual_lock_via_keypad.failed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string status: description: Status of the action. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - action_attempt_id - action_type - status - event_type type: object x-route-path: /action_attempts - description: >- A [Connect Webview](/core-concepts/connect-webviews) login succeeded. properties: connect_webview_id: description: >- ID of the affected [Connect Webview](/core-concepts/connect-webviews). format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account; present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with this connect webview, if any. type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connect_webview.login_succeeded type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connect_webview_id - event_type - connected_account_id type: object x-route-path: /connect_webviews - description: A [Connect Webview](/core-concepts/connect-webviews) login failed. properties: connect_webview_id: description: >- ID of the affected [Connect Webview](/core-concepts/connect-webviews). format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - connect_webview.login_failed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connect_webview_id - event_type type: object x-route-path: /connect_webviews - description: >- The status of a [device](/core-concepts/devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.connected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- A [device](/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.added type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- A managed device was successfully converted to an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.converted_to_unmanaged type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- An [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.unmanaged.converted_to_managed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices/unmanaged - description: >- The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.unmanaged.connected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices/unmanaged - description: >- The status of a [device](/core-concepts/devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the affected device. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array error_code: description: Error code associated with the disconnection event, if any. enum: - account_disconnected - hub_disconnected - device_disconnected type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.disconnected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - error_code - connected_account_errors - connected_account_warnings - device_errors - device_warnings type: object x-route-path: /devices - description: >- The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the affected device. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array error_code: description: Error code associated with the disconnection event, if any. enum: - account_disconnected - hub_disconnected - device_disconnected type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.unmanaged.disconnected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - error_code - connected_account_errors - connected_account_warnings - device_errors - device_warnings type: object x-route-path: /devices/unmanaged - description: >- A [device](/core-concepts/devices) detected that it was tampered with, for example, opened or moved. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.tampered type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- A [device](/core-concepts/devices) battery level dropped below the low threshold. properties: battery_level: description: >- Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. format: float maximum: 1 minimum: 0 type: number connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.low_battery type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - battery_level type: object x-route-path: /devices - description: >- A [device](/core-concepts/devices) battery status changed since the last `battery_status_changed` event. properties: battery_level: description: >- Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. format: float maximum: 1 minimum: 0 type: number battery_status: description: >- Battery status of the affected device, calculated from the numeric `battery_level` value. enum: - critical - low - good - full type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.battery_status_changed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - battery_status - battery_level type: object x-route-path: /devices - description: >- A [device](/core-concepts/devices) was removed externally from the [connected account](/core-concepts/connected-accounts). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.removed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: A [device](/core-concepts/devices) was deleted. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- Seam detected that a [device](/core-concepts/devices) is using a third-party integration that will interfere with Seam device management. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.third_party_integration_detected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- Seam detected that a [device](/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.third_party_integration_no_longer_detected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- A [Salto device](/device-and-system-integration-guides/salto-locks) activated privacy mode. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.salto.privacy_mode_activated type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- A [Salto device](/device-and-system-integration-guides/salto-locks) deactivated privacy mode. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.salto.privacy_mode_deactivated type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: Seam detected a flaky [device](/core-concepts/devices) connection. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the affected device. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.connection_became_flaky type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings type: object x-route-path: /devices - description: >- Seam detected that a previously-flaky [device](/core-concepts/devices) connection stabilized. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.connection_stabilized type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- A third-party subscription is required to use all [device](/core-concepts/devices) features. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the affected device. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.error.subscription_required type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings type: object x-route-path: /devices - description: >- A third-party subscription is active or no longer required to use all [device](/core-concepts/devices) features. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.error.subscription_required.resolved type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- An accessory keypad was connected to a [device](/core-concepts/devices). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.accessory_keypad_connected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- An accessory keypad was disconnected from a [device](/core-concepts/devices). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_errors: description: Errors associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string connected_account_warnings: description: Warnings associated with the connected account. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_errors: description: Errors associated with the device. items: properties: created_at: description: Date and time at which Seam created the error. format: date-time type: string error_code: description: >- Unique identifier of the type of error. Enables quick recognition and categorization of the issue. type: string message: description: >- Detailed description of the error. Provides insights into the issue and potentially how to rectify it. type: string required: - created_at - message - error_code type: object type: array device_id: description: ID of the affected device. format: uuid type: string device_warnings: description: Warnings associated with the device. items: properties: created_at: description: Date and time at which Seam created the warning. format: date-time type: string message: description: >- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. type: string warning_code: description: >- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. type: string required: - created_at - message - warning_code type: object type: array event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.accessory_keypad_disconnected type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - connected_account_errors - connected_account_warnings - device_errors - device_warnings type: object x-route-path: /devices - description: >- Extended periods of noise or noise exceeding a [threshold](/capability-guides/noise-sensors#what-is-a-threshold) were detected. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - noise_sensor.noise_threshold_triggered type: string minut_metadata: additionalProperties: {} description: Metadata from Minut. type: object noise_level_decibels: description: Detected noise level in decibels. format: float type: number noise_level_nrs: description: Detected noise level in Noiseaware Noise Risk Score (NRS). format: float type: number noise_threshold_id: description: ID of the noise threshold that was triggered. format: uuid type: string noise_threshold_name: description: Name of the noise threshold that was triggered. type: string noiseaware_metadata: additionalProperties: {} description: Metadata from Noiseaware. type: object occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /noise_sensors/noise_thresholds - description: A [lock](/low-level-apis/smart-locks) was locked. properties: access_code_id: description: ID of the access code that was used to lock the device. format: uuid type: string access_code_is_managed: description: >- Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. type: boolean action_attempt_id: description: >- ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - lock.locked type: string is_via_bluetooth: description: |2- Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action. type: boolean is_via_nfc: description: |2- Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action. type: boolean method: description: >- Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. enum: - keycode - manual - automatic - unknown - remote type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - method type: object x-route-path: /locks - description: A [lock](/low-level-apis/smart-locks) was unlocked. properties: access_code_id: description: >- ID of the access code that was used to unlock the affected device. format: uuid type: string access_code_is_managed: description: >- Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. type: boolean acs_entrance_id: description: |2- undocumented: Unreleased. --- ID of the ACS entrance associated with the unlock event. format: uuid type: string acs_system_id: description: |2- undocumented: Unreleased. --- ID of the ACS system associated with the unlock event. format: uuid type: string acs_user_id: description: |2- undocumented: Unreleased. --- ID of the ACS user associated with the unlock event. format: uuid type: string action_attempt_id: description: >- ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - lock.unlocked type: string is_via_bluetooth: description: |2- Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action. type: boolean is_via_nfc: description: |2- Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action. type: boolean method: description: >- Method by which the lock was unlocked. `keycode`: an [access code](/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. enum: - keycode - manual - automatic - unknown - remote type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string user_identity_id: description: |2- undocumented: Unreleased. --- ID of the user identity associated with the unlock event. format: uuid type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - connected_account_id - event_type - method type: object x-route-path: /locks - description: >- The [lock](/low-level-apis/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device. properties: access_code_id: description: ID of the access code that was used in the unlock attempts. format: uuid type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - lock.access_denied type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /locks - description: >- A thermostat [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) was activated. properties: climate_preset_key: description: Key of the climate preset that was activated. type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - thermostat.climate_preset_activated type: string is_fallback_climate_preset: description: >- Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat. type: boolean occurred_at: description: Date and time at which the event occurred. format: date-time type: string thermostat_schedule_id: description: >- ID of the thermostat schedule that prompted the affected climate preset to be activated. format: uuid nullable: true type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - thermostat_schedule_id - climate_preset_key - is_fallback_climate_preset type: object x-route-path: /thermostats - description: >- A [thermostat](/capability-guides/thermostats) was adjusted manually. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string cooling_set_point_celsius: description: >- Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points). format: float type: number cooling_set_point_fahrenheit: description: >- Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points). format: float type: number created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - thermostat.manually_adjusted type: string fan_mode_setting: description: >- Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. enum: - auto - 'on' - circulate type: string heating_set_point_celsius: description: >- Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points). format: float type: number heating_set_point_fahrenheit: description: >- Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points). format: float type: number hvac_mode_setting: description: >- Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. enum: - 'off' - heat - cool - heat_cool - eco type: string method: description: >- Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat. enum: - seam - external type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - method type: object x-route-path: /thermostats - description: >- A [thermostat's](/capability-guides/thermostats) temperature reading exceeded the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - thermostat.temperature_threshold_exceeded type: string lower_limit_celsius: description: Lower temperature limit, in °C, defined by the set threshold. format: float nullable: true type: number lower_limit_fahrenheit: description: Lower temperature limit, in °F, defined by the set threshold. format: float nullable: true type: number occurred_at: description: Date and time at which the event occurred. format: date-time type: string temperature_celsius: description: Temperature, in °C, reported by the affected thermostat. format: float type: number temperature_fahrenheit: description: Temperature, in °F, reported by the affected thermostat. format: float type: number upper_limit_celsius: description: Upper temperature limit, in °C, defined by the set threshold. format: float nullable: true type: number upper_limit_fahrenheit: description: Upper temperature limit, in °F, defined by the set threshold. format: float nullable: true type: number workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - temperature_celsius - temperature_fahrenheit - upper_limit_celsius - upper_limit_fahrenheit - lower_limit_celsius - lower_limit_fahrenheit type: object x-route-path: /thermostats - description: >- A [thermostat's](/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - thermostat.temperature_threshold_no_longer_exceeded type: string lower_limit_celsius: description: Lower temperature limit, in °C, defined by the set threshold. format: float nullable: true type: number lower_limit_fahrenheit: description: Lower temperature limit, in °F, defined by the set threshold. format: float nullable: true type: number occurred_at: description: Date and time at which the event occurred. format: date-time type: string temperature_celsius: description: Temperature, in °C, reported by the affected thermostat. format: float type: number temperature_fahrenheit: description: Temperature, in °F, reported by the affected thermostat. format: float type: number upper_limit_celsius: description: Upper temperature limit, in °C, defined by the set threshold. format: float nullable: true type: number upper_limit_fahrenheit: description: Upper temperature limit, in °F, defined by the set threshold. format: float nullable: true type: number workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - temperature_celsius - temperature_fahrenheit - upper_limit_celsius - upper_limit_fahrenheit - lower_limit_celsius - lower_limit_fahrenheit type: object x-route-path: /thermostats - description: >- A [thermostat's](/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string desired_temperature_celsius: description: >- Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point. format: float type: number desired_temperature_fahrenheit: description: >- Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point. format: float type: number device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - thermostat.temperature_reached_set_point type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string temperature_celsius: description: Temperature, in °C, reported by the affected thermostat. format: float type: number temperature_fahrenheit: description: Temperature, in °F, reported by the affected thermostat. format: float type: number workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - temperature_celsius - temperature_fahrenheit type: object x-route-path: /thermostats - description: >- A [thermostat's](/capability-guides/thermostats) reported temperature changed by at least 1 °C. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - thermostat.temperature_changed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string temperature_celsius: description: Temperature, in °C, reported by the affected thermostat. format: float type: number temperature_fahrenheit: description: Temperature, in °F, reported by the affected thermostat. format: float type: number workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - temperature_celsius - temperature_fahrenheit type: object x-route-path: /thermostats - description: The name of a [device](/core-concepts/devices) was changed. properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string device_name: description: The new name of the affected device. type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.name_changed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - device_name type: object x-route-path: /devices - description: >- A [camera](/core-concepts/devices) was activated, for example, by motion detection. properties: activation_reason: description: The reason the camera was activated. enum: - motion_detected type: string connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - camera.activated type: string image_url: description: URL to a thumbnail image captured at the time of activation. format: uri type: string motion_sub_type: description: Sub-type of motion detected, if available. enum: - human - vehicle - package - other type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string video_url: description: URL to a short video clip captured at the time of activation. format: uri type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type - activation_reason type: object x-route-path: /devices - description: A doorbell button was pressed on a [device](/core-concepts/devices). properties: connected_account_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the connected account, present when connected_account_id is provided. type: object connected_account_id: description: >- ID of the [connected account](/core-concepts/connected-accounts) associated with the event. format: uuid type: string created_at: description: Date and time at which the event was created. format: date-time type: string customer_key: description: The customer key associated with the device, if any. type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device, present when device_id is provided. type: object device_id: description: ID of the affected device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - device.doorbell_rang type: string image_url: description: >- URL to a thumbnail image captured at the time the doorbell was pressed. format: uri type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string video_url: description: >- URL to a short video clip captured at the time the doorbell was pressed. format: uri type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - connected_account_id - event_type type: object x-route-path: /devices - description: >- An [enrollment automation](/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted. properties: created_at: description: Date and time at which the event was created. format: date-time type: string enrollment_automation_id: description: ID of the affected enrollment automation. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - enrollment_automation.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - enrollment_automation_id - event_type type: object x-route-path: /user_identities/enrollment_automations - description: A phone device was deactivated. properties: created_at: description: Date and time at which the event was created. format: date-time type: string device_custom_metadata: additionalProperties: oneOf: - type: string - type: boolean description: >- Custom metadata of the device; present when device_id is provided. type: object device_id: description: ID of the affected phone device. format: uuid type: string event_id: description: ID of the event. format: uuid type: string event_type: enum: - phone.deactivated type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - device_id - event_type type: object x-route-path: /phones - description: A device was added or removed from a space. properties: acs_entrance_ids: description: IDs of all ACS entrances currently attached to the space. items: format: uuid type: string type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_ids: description: IDs of all devices currently attached to the space. items: format: uuid type: string type: array event_id: description: ID of the event. format: uuid type: string event_type: description: Type of the event. enum: - space.device_membership_changed type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string space_id: description: ID of the affected space. format: uuid type: string space_key: description: Unique key for the space within the workspace. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - space_id - event_type - device_ids - acs_entrance_ids type: object x-route-path: /spaces - description: A space was created. properties: acs_entrance_ids: description: >- IDs of all ACS entrances attached to the space when it was created. items: format: uuid type: string type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_ids: description: IDs of all devices attached to the space when it was created. items: format: uuid type: string type: array event_id: description: ID of the event. format: uuid type: string event_type: description: Type of the event. enum: - space.created type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string space_id: description: ID of the affected space. format: uuid type: string space_key: description: Unique key for the space within the workspace. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - space_id - event_type - device_ids - acs_entrance_ids type: object x-route-path: /spaces - description: A space was deleted. properties: acs_entrance_ids: description: >- IDs of all ACS entrances currently attached to the space when it was deleted. items: format: uuid type: string type: array created_at: description: Date and time at which the event was created. format: date-time type: string device_ids: description: IDs of all devices attached to the space when it was deleted. items: format: uuid type: string type: array event_id: description: ID of the event. format: uuid type: string event_type: description: Type of the event. enum: - space.deleted type: string occurred_at: description: Date and time at which the event occurred. format: date-time type: string space_id: description: ID of the affected space. format: uuid type: string space_key: description: Unique key for the space within the workspace. type: string workspace_id: description: >- ID of the [workspace](/core-concepts/workspaces) associated with the event. format: uuid type: string required: - event_id - workspace_id - created_at - occurred_at - space_id - event_type - device_ids - acs_entrance_ids type: object x-route-path: /spaces x-route-path: /events securitySchemes: client_session: bearerFormat: Client Session Token scheme: bearer type: http api_key: bearerFormat: API Key scheme: bearer type: http pat_with_workspace: bearerFormat: API Token scheme: bearer type: http console_session_with_workspace: bearerFormat: Console Session Token scheme: bearer type: http client_session_with_customer: bearerFormat: Customer Client Session Token scheme: bearer type: http ````