POST/v3/webhooksCreate a v3 webhook

Create a webhook that subscribes on event types. We recommend an HMAC to validate the integrity of our messages. The HMAC is calculated by applying the secretHmac on the entire payload as string. It is provided to the webhook endpoint in the X-Bold-Hmac-SHA256 header. The secretHttp value is passed back via the X-Bold-Secret header. Refer to GET v2/events for the event output format your application will be receiving.
The types field selects which events are delivered. If left empty, all supported events are emitted.

header	Authorization	Authentication token (bearer token or API key).
{ "organizationId" : Number, "secretHttp" : String, "webhookUrl" : String, "types" : ["DeviceActivation" / "DeviceDeactivation" / "DeviceBoot" / "DeviceStatus" / "DeviceTamperVibration" / "DeviceTamperRotations" / "DeviceTamperFaultyPin" / "DeviceLocked" / "MatterCommissioning" / "ThreadConnection"] }

Response

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

Example: Connect a v3 Webhook to our platform

POST/v3/webhooks

header	Authorization	Bearer ab25e190-8c9a-4e3d-b77e-c25552f572fe
{ "organizationId": 1, "secretHttp": "vuktWTDReGXCbFFz", "webhookUrl": "https://webhooks.athom.com/webhook/YYYYY", "types": ["DeviceActivation", "DeviceLocked"] }

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": "Yh5vDHNGG9rV00wD2K9Emf0Va5iBkqsC" }

← Webhooks API

POST/v3/webhooksCreate a v3 webhook

Response

Example: Connect a v3 Webhook to our platform

POST/v3/webhooks

Response

Example: Reject a v3 Webhook whose URL is already used by a v2 webhook