Ably · Schema

ifttt_rule_patch

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
status string The status of the rule. Rules can be enabled or disabled.
ruleType string The type of rule. In this case IFTTT. See the Ably integrations docs for further information.
requestMode string Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the source object
target object
View JSON Schema on GitHub

JSON Schema

ably-ifttt-rule-patch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ifttt_rule_patch",
  "title": "ifttt_rule_patch",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the rule. Rules can be enabled or disabled.",
      "example": "enabled"
    },
    "ruleType": {
      "type": "string",
      "enum": [
        "http/ifttt"
      ],
      "description": "The type of rule. In this case IFTTT. See the Ably <a href=\"https://ably.com/docs/general/integrations\">integrations docs</a> for further information.",
      "example": "http/ifttt"
    },
    "requestMode": {
      "type": "string",
      "description": "Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the <a href=\"https://ably.com/docs/general/webhooks#batching\">batching docs</a>.",
      "example": "single"
    },
    "source": {
      "$ref": "#/components/schemas/rule_source_patch"
    },
    "target": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "webhookKey": {
          "type": "string",
          "description": "The key in the Webhook Service Documentation page of your IFTTT account.",
          "example": "aBcd12Ef98-Z1ab3yTe-EXAMPLE"
        },
        "eventName": {
          "type": "string",
          "description": "The Event name is used to identify the IFTTT applet that will receive the Event, make sure the name matches the name of the IFTTT applet.",
          "example": "MyAppletName"
        }
      }
    }
  },
  "required": [
    "ruleType"
  ]
}