Webhook Integrations Webservice

Subscribe Zapier webhook

Setup a Zapier webhook

post/api/integrations/webhooks/subscribeZapierWebhook

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/integrations/webhooks/subscribeZapierWebhook
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

backoffSecinteger nullable

Backoff time in seconds

doorState'OPEN' | 'CLOSED' | 'AJAR'

Door state for door sensor webhooks

hookUrlstring nullable

Zapier webhook URL

humidityLowerThresholdnumber float nullable

Lower humidity threshold for environmental sensors

humidityUpperThresholdnumber float nullable

Upper humidity threshold for environmental sensors

tempLowerThresholdnumber float nullable

Lower temperature threshold for environmental sensors

tempUpperThresholdnumber float nullable

Upper temperature threshold for environmental sensors

uuidsstring[] nullable

Set of device UUIDs to monitor

zapEnum'BUTTON_EVENTS' | 'DOOR_SENSOR_EVENTS' | 'ENVIRONMENTAL_SENSOR_EVENTS' | 'RULE_EVENTS'

Zapier integration type

Example request

{
  "backoffSec": 30,
  "hookUrl": "https://hooks.zapier.com/hooks/catch/123456/abc123/",
  "humidityLowerThreshold": 30,
  "humidityUpperThreshold": 80,
  "tempLowerThreshold": 65,
  "tempUpperThreshold": 85.5,
  "uuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable
webhookIdstring RUUID nullable

base 64 (url-safe) uuid string

Example response

{
  "webhookId": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.