Skip to main content

Troubleshooting Errors

Error responses and correlation IDs

If an error response is returned by SmartThings, it will contain a requestId and other information about the error. This should be included when reporting issues to SmartThings.

{
"requestId": "031fec1a-f19f-470a-a7da-710569082846"
"error": {
"code": "ConstraintViolationError",
"message": "Validation errors occurred while process your request.",
"details": [
{ "code": "PatternError", "target": "latitude", "message": "Invalid format." },
{ "code": "SizeError", "target": "name", "message": "Too small." },
{ "code": "SizeError", "target": "description", "message": "Too big." }
]
}
}

If you are experiencing issues with the request being issued to your SmartApp, include the requestId value sent with each request:

{
"lifecycle": "INSTALL",
"executionId": "b328f242-c602-4204-8d73-33c48ae180af",
"locale": "en",
"version": "1.0.0",
"installData": {...}
}

General troubleshooting tips

  • If you are experiencing authorization issues (typically indicated by the SmartThings API returning a 401 or 403), ensure your app has requested, and the user has authorized, the proper permissions.
  • Ensure your app is not exceeding any rate limits.