zapier_rule_patch

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/zapier_rule_patch",
  "title": "zapier_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/zapier"
      ],
      "description": "The type of rule. In this case Zapier. See the Ably <a href=\"https://ably.com/docs/general/integrations\">integrations docs</a> for further information.",
      "example": "http/zapier"
    },
    "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_patch"
    },
    "target": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "The webhook URL that Ably will POST events to.",
          "example": "https://example.com/webhooks"
        },
        "headers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the header.",
                "example": "User-Agent"
              },
              "value": {
                "type": "string",
                "description": "The value of the header.",
                "example": "user-agent-string"
              }
            }
          },
          "description": "If you have additional information to send, you'll need to include the relevant headers.",
          "example": [
            {
              "name": "User-Agent",
              "value": "user-agent-string"
            },
            {
              "name": "headerName",
              "value": "headerValue"
            }
          ]
        },
        "signingKeyId": {
          "type": "string",
          "nullable": true,
          "description": "The signing key ID for use in `batch` mode. Ably will optionally sign the payload using an API key ensuring your servers can validate the payload using the private API key. See the <a href=\"https://ably.com/docs/general/webhooks#security\">webhooks security docs</a> for more information.",
          "example": "bw66AB"
        }
      }
    }
  },
  "required": [
    "ruleType"
  ]
}