Webhooks
Webhooks Smart Module endpoint for triggering command-based webhook calls.
Endpoints
Send command
Endpoint
put /homes/{homeId}/smartModules/{moduleId}/command
Description
Send a command object to a Smart Module and trigger a webhook call to an external server. The specified Smart Module must have a command webhook defined in its configuration.
Path Parameters
homeId
integer
required
The unique id for a home.
moduleId
string
required
The unique id for a smart module.
Request Headers What's this?
Authorization
required
Must contain a user or project API key.
Request Body
action
string
required
Action to be taken by Smart Module.
parameters
object
Action-specific parameters. This is opaque to the cloud service.
Response
- 204Data have been sent successfully.
- 401Authorization is required to access this resource.
- 403Request failed because of invalid data or denied permission.
- 404The requested command does not exist or is not accessible.
- 500An unexpected error has occurred.
- 503The service is temporarily unavailable.
Request Body Sample
{
"action": "set-alarm-state",
"parameters": {
"rooms": [ "living-room", "master-bedroom" ],
"armed": true
}
}