POST/v2/webhooksCreate a webhook

Create a webhook for our platform to interact with
Due to the security-sensitive nature of our products, we recommend an HMAC to validate the integrity of our messages. Optionally, you can provide us with a simple secret.

header	Authorization	Authentication token (bearer token or API key).
{ "organizationId" : Number, "deviceIds" : [Number], "deviceGroupIds" : [Number], "secretHttp" : String, "webhookUrl" : String, "topics" : ["DeviceActivationEvents" / "DeviceDeactivationEvents" / "DeviceStatusEvents" / "DeviceTamperEvents"] }

Response

status	401	Invalid authentication token
{ "id" : Number, "secretHmac" : String }

Example: Connect a Webhook to our platform

POST/v2/webhooks

header	Authorization	Bearer 6ff09084-6077-4f7e-866b-8326ee0ff69f
{ "organizationId": 1, "deviceIds": [1, 2, 3], "secretHttp": "5wkLQgH9M1cosAFK", "webhookUrl": "https://webhooks.athom.com/webhook/XXXXX", "topics": ["DeviceActivationEvents", "DeviceDeactivationEvents", "DeviceStatusEvents", "DeviceTamperEvents"] }

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
{ "id": 2, "secretHmac": "7j8s5svgcLW4zBX7YEEdgW7XQM6ktTK2" }

Example: Connect an insecure Webhook to our platform

POST/v2/webhooks

header	Authorization	Bearer 97d6e0b6-388e-445e-9da4-b55a3f511c3d
{ "organizationId": 1, "deviceIds": [1, 2, 3], "secretHttp": "ezb5BKTcqA5ESjgS", "webhookUrl": "http://webhooks.athom.com/webhook/XXXXX", "topics": ["DeviceActivationEvents", "DeviceDeactivationEvents", "DeviceStatusEvents", "DeviceTamperEvents"] }

Response

status	400
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
{ "message": "Unsupported protocol: We only support https for now.", "code": "WebhookUnsupportedProtocol", "errorMessage": "Unsupported protocol: We only support https for now.", "errorCode": "WebhookUnsupportedProtocol" }