Represents a . A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
Properties
account_typeString
Type of connected account.
account_type_display_nameString
Display name for the connected account type.
automatically_manage_new_devicesBoolean
connected_account_idUUID
Unique identifier for the connected account.
created_atDatetime
Date and time at which the connected account was created.
custom_metadataRecord
customer_keyString
Your unique key for the customer associated with this connected account.
Errors associated with the connected account.
The specific structure of each object in this list depends on the value of its error_code field.
Variants:
account_disconnected
Account is disconnected.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
account_disconnected
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
invalid_credentials
Credentials provided were invalid.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
invalid_credentials
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
bridge_disconnected
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
bridge_disconnected
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
salto_ks_subscription_limit_exceeded
Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_subscription_limit_exceeded
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
salto_ks_metadataObject
Salto KS metadata associated with the connected account that has an error.
Child Properties
sitesListof Objects
Salto sites associated with the connected account that has an error.
site_idString
ID of a Salto site associated with the connected account that has an error.
site_nameString
Name of a Salto site associated with the connected account that has an error.
site_user_subscription_limitNumber
Subscription limit of site users for a Salto site associated with the connected account that has an error.
subscribed_site_user_countNumber
Count of subscribed site users for a Salto site associated with the connected account that has an error.
user_identifierObject
User identifier associated with the connected account.
Child Properties
api_urlString
API URL for the user identifier associated with the connected account.
emailString
Email address of the user identifier associated with the connected account.
exclusiveBoolean
Indicates whether the user identifier associated with the connected account is exclusive.
phoneString
Phone number of the user identifier associated with the connected account.
usernameString
Username of the user identifier associated with the connected account.
Warnings associated with the connected account.
The specific structure of each object in this list depends on the value of its warning_code field.
Variants:
scheduled_maintenance_window
Scheduled downtime planned for the connected account.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
scheduled_maintenance_window
unknown_issue_with_connected_account
An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
unknown_issue_with_connected_account
salto_ks_subscription_limit_almost_reached
Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
salto_ks_metadataObject
Salto KS metadata associated with the connected account that has a warning.
Child Properties
sitesListof Objects
Salto sites associated with the connected account that has a warning.
site_idString
ID of a Salto site associated with the connected account that has a warning.
site_nameString
Name of a Salto site associated with the connected account that has a warning.
site_user_subscription_limitNumber
Subscription limit of site users for a Salto site associated with the connected account that has a warning.
subscribed_site_user_countNumber
Count of subscribed site users for a Salto site associated with the connected account that has a warning.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_subscription_limit_almost_reached
Errors
account_disconnected
Account is disconnected.
invalid_credentials
Credentials provided were invalid.
bridge_disconnected
salto_ks_subscription_limit_exceeded
Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
Warnings
scheduled_maintenance_window
Scheduled downtime planned for the connected account.
unknown_issue_with_connected_account
An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.
salto_ks_subscription_limit_almost_reached
Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
Events
connected_account.connected
Properties
connect_webview_idUUID
ID of the Connect Webview associated with the event.
connected_account_idUUID
ID of the affected connected account.
created_atDatetime
Date and time at which the event was created.
event_idUUID
ID of the event.
event_typeEnum
Value: connected_account.connected
occurred_atDatetime
Date and time at which the event occurred.
workspace_idUUID
ID of the workspace associated with the event.
connected_account.created
Properties
connect_webview_idUUID
ID of the Connect Webview associated with the event.
connected_account_idUUID
ID of the affected connected account.
created_atDatetime
Date and time at which the event was created.
event_idUUID
ID of the event.
event_typeEnum
Value: connected_account.created
occurred_atDatetime
Date and time at which the event occurred.
workspace_idUUID
ID of the workspace associated with the event.
connected_account.successful_login
Properties
connect_webview_idUUID
ID of the Connect Webview associated with the event.
Indicates whether Seam should for the connected account to make these devices available for use and management by the Seam API.
Set of key:value pairs. Adding custom metadata to a resource, such as a , , or , enables you to store custom information, like customer details or internal IDs from your application.
Listof Objects
Indicates that the Seam API cannot communicate with , for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also .
Listof Objects
Indicates that the Seam API cannot communicate with , for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also .
A was connected for the first time or was reconnected after being disconnected.
A was created.
A had a successful login using a .
A was disconnected.
A completed the first sync with Seam, and the corresponding devices or systems are now available.
A was deleted.
A completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
Deletes a specified .
Returns a specified .
Returns a list of all .
Request a sync attempt for the specified connected_account_id.