Skip to main content
POST
/
api
/
integrations
/
subscribeZapierWebhook
Subscribe Zapier Webhook
curl --request POST \
  --url https://api2.rhombussystems.com/api/integrations/subscribeZapierWebhook \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "backoffSec": 30,
  "doorState": "OPEN",
  "hookUrl": "https://hooks.zapier.com/hooks/catch/123456/abc123/",
  "humidityLowerThreshold": 30,
  "humidityUpperThreshold": 80,
  "tempLowerThreshold": 65,
  "tempUpperThreshold": 85.5,
  "uuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "zapEnum": "BUTTON_EVENTS"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>",
  "webhookId": "AAAAAAAAAAAAAAAAAAAAAA"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for subscribing to Zapier webhook events.

​
backoffSec
integer<int32> | null

Backoff time in seconds

Example:

30

​
doorState
enum<string>

Door state for door sensor webhooks

Available options:
OPEN,
CLOSED,
AJAR
​
hookUrl
string | null

Zapier webhook URL

Example:

"https://hooks.zapier.com/hooks/catch/123456/abc123/"

​
humidityLowerThreshold
number<float> | null

Lower humidity threshold for environmental sensors

Example:

30

​
humidityUpperThreshold
number<float> | null

Upper humidity threshold for environmental sensors

Example:

80

​
tempLowerThreshold
number<float> | null

Lower temperature threshold for environmental sensors

Example:

65

​
tempUpperThreshold
number<float> | null

Upper temperature threshold for environmental sensors

Example:

85.5

​
uuids
(string<RUUID> | null)[] | null

Set of device UUIDs to monitor

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
zapEnum
enum<string>

Zapier integration type

Available options:
BUTTON_EVENTS,
DOOR_SENSOR_EVENTS,
ENVIRONMENTAL_SENSOR_EVENTS,
RULE_EVENTS

Response

200 - application/json

OK

Response object for Zapier webhook subscription.

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null
​
webhookId
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"