Ably · Schema
unsupported_rule_response
RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The rule ID. |
| appId | string | The Ably application ID. |
| version | string | API version. Events and the format of their payloads are versioned. Please see the webhooks docs. |
| status | string | The status of the rule. Rules can be enabled or disabled. |
| created | number | Unix timestamp representing the date and time of creation of the rule. |
| modified | number | Unix timestamp representing the date and time of last modification of the rule. |
| _links | object | |
| ruleType | string | This rule type is currently unsupported. |
| requestMode | string | This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same requ |
| source | object | |
| target | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/unsupported_rule_response",
"title": "unsupported_rule_response",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The rule ID.",
"example": "83IzAB"
},
"appId": {
"type": "string",
"description": "The Ably application ID.",
"example": "28GY6a"
},
"version": {
"type": "string",
"description": "API version. Events and the format of their payloads are versioned. Please see the <a href=\"https://ably.com/docs/general/webhooks\">webhooks docs</a>.",
"example": "1.2"
},
"status": {
"type": "string",
"description": "The status of the rule. Rules can be enabled or disabled.",
"example": "enabled"
},
"created": {
"type": "number",
"description": "Unix timestamp representing the date and time of creation of the rule.",
"example": 1602844091815
},
"modified": {
"type": "number",
"description": "Unix timestamp representing the date and time of last modification of the rule.",
"example": 1614679682091
},
"_links": {
"type": "object",
"nullable": true
},
"ruleType": {
"type": "string",
"description": "This rule type is currently unsupported.",
"enum": [
"unsupported"
],
"example": "unsupported"
},
"requestMode": {
"type": "string",
"description": "This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same request. You can read more about the difference between single and batched events in the Ably <a href=\"https://ably.com/docs/general/webhooks#batching\">batching docs</a>.",
"example": "single"
},
"source": {
"$ref": "#/components/schemas/rule_source"
},
"target": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"description": "The webhook URL that Ably will POST events to.",
"example": "https://example.com/webhooks"
}
},
"required": [
"url"
]
}
},
"required": [
"ruleType",
"requestMode",
"source",
"target"
]
}