@camunda/connectors-element-templates 1.0.7 → 1.0.8

package/src/element-templates/http-polling-connector.json

@@ -3,7 +3,7 @@
     "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
     "name": "HTTP Polling Intermediate Catch Event Connector",
     "id": "io.camunda.connectors.http.Polling",
-    "version": 3,
+    "version": 2,
     "description": "Polls endpoint at regular intervals",
     "icon": {
       "contents": "data:image/svg+xml;utf8,%3C%3Fxml version='1.0'%3F%3E%3Csvg width='18' height='18' xmlns='http://www.w3.org/2000/svg' xmlns:svg='http://www.w3.org/2000/svg'%3E%3Cg class='layer'%3E%3Ctitle%3ELayer 1%3C/title%3E%3Cpath d='m17.03,9c0,4.45 -3.6,8.05 -8.05,8.05c-4.45,0 -8.05,-3.6 -8.05,-8.05c0,-4.45 3.6,-8.05 8.05,-8.05c4.45,0 8.05,3.6 8.05,8.05z' fill='%23505562' id='svg_1'/%3E%3Cpath d='m4.93,14.16l1.85,-10.45l3.36,0c1.05,0 1.84,0.27 2.37,0.81c0.54,0.53 0.8,1.21 0.8,2.06c0,0.86 -0.24,1.58 -0.73,2.13c-0.47,0.55 -1.12,0.93 -1.95,1.14l-0.48,0.09l-0.53,0.03l-0.6,0.05l-1.79,0l-0.73,4.14l-1.58,0zm2.57,-5.57l1.74,0c0.76,0 1.35,-0.17 1.78,-0.5c0.44,-0.35 0.65,-0.82 0.65,-1.42c0,-0.48 -0.15,-0.85 -0.44,-1.12c-0.3,-0.28 -0.77,-0.42 -1.42,-0.42l-1.7,0l-0.61,3.46z' fill='white' id='svg_2'/%3E%3C/g%3E%3C/svg%3E"
@@ -941,7 +941,7 @@
     "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
     "name": "HTTP Polling Intermediate Catch Event Connector",
     "id": "io.camunda.connectors.http.Polling",
-    "version": 2,
+    "version": 3,
     "description": "Polls endpoint at regular intervals",
     "icon": {
       "contents": "data:image/svg+xml;utf8,%3C%3Fxml version='1.0'%3F%3E%3Csvg width='18' height='18' xmlns='http://www.w3.org/2000/svg' xmlns:svg='http://www.w3.org/2000/svg'%3E%3Cg class='layer'%3E%3Ctitle%3ELayer 1%3C/title%3E%3Cpath d='m17.03,9c0,4.45 -3.6,8.05 -8.05,8.05c-4.45,0 -8.05,-3.6 -8.05,-8.05c0,-4.45 3.6,-8.05 8.05,-8.05c4.45,0 8.05,3.6 8.05,8.05z' fill='%23505562' id='svg_1'/%3E%3Cpath d='m4.93,14.16l1.85,-10.45l3.36,0c1.05,0 1.84,0.27 2.37,0.81c0.54,0.53 0.8,1.21 0.8,2.06c0,0.86 -0.24,1.58 -0.73,2.13c-0.47,0.55 -1.12,0.93 -1.95,1.14l-0.48,0.09l-0.53,0.03l-0.6,0.05l-1.79,0l-0.73,4.14l-1.58,0zm2.57,-5.57l1.74,0c0.76,0 1.35,-0.17 1.78,-0.5c0.44,-0.35 0.65,-0.82 0.65,-1.42c0,-0.48 -0.15,-0.85 -0.44,-1.12c-0.3,-0.28 -0.77,-0.42 -1.42,-0.42l-1.7,0l-0.61,3.46z' fill='white' id='svg_2'/%3E%3C/g%3E%3C/svg%3E"
@@ -1405,5 +1405,634 @@
     "engines": {
       "camunda": "^8.3"
     }
+  },
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "HTTP Polling Intermediate Catch Event Connector",
+    "id": "io.camunda.connectors.http.Polling",
+    "description": "Polls endpoint at regular intervals",
+    "metadata": {
+      "keywords": []
+    },
+    "documentationRef": "https://docs.camunda.io/docs/components/connectors/protocol/polling/",
+    "version": 4,
+    "category": {
+      "id": "connectors",
+      "name": "Connectors"
+    },
+    "appliesTo": ["bpmn:IntermediateCatchEvent", "bpmn:IntermediateThrowEvent"],
+    "elementType": {
+      "value": "bpmn:IntermediateCatchEvent",
+      "eventDefinition": "bpmn:MessageEventDefinition"
+    },
+    "engines": {
+      "camunda": "^8.8"
+    },
+    "groups": [
+      {
+        "id": "authentication",
+        "label": "Authentication"
+      },
+      {
+        "id": "endpoint",
+        "label": "HTTP Polling configuration"
+      },
+      {
+        "id": "interval",
+        "label": "HTTP Polling Interval"
+      },
+      {
+        "id": "timeout",
+        "label": "Connection timeout"
+      },
+      {
+        "id": "activation",
+        "label": "Activation"
+      },
+      {
+        "id": "correlation",
+        "label": "Correlation",
+        "tooltip": "Learn more about message correlation in the <a href=\"https://docs.camunda.io/docs/components/concepts/messages/#message-correlation-overview\">documentation</a>."
+      },
+      {
+        "id": "output",
+        "label": "Output mapping"
+      }
+    ],
+    "properties": [
+      {
+        "value": "io.camunda:http-polling:1",
+        "binding": {
+          "name": "inbound.type",
+          "type": "zeebe:property"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "authentication.type",
+        "label": "Type",
+        "description": "Choose the authentication type. Select 'None' if no authentication is necessary",
+        "value": "noAuth",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.type",
+          "type": "zeebe:property"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "API key",
+            "value": "apiKey"
+          },
+          {
+            "name": "Basic",
+            "value": "basic"
+          },
+          {
+            "name": "Bearer token",
+            "value": "bearer"
+          },
+          {
+            "name": "None",
+            "value": "noAuth"
+          },
+          {
+            "name": "OAuth 2.0",
+            "value": "oauth-client-credentials-flow"
+          }
+        ]
+      },
+      {
+        "id": "authentication.apiKeyLocation",
+        "label": "Api key location",
+        "description": "Choose type: Send API key in header or as query parameter.",
+        "optional": false,
+        "value": "headers",
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.apiKeyLocation",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "apiKey",
+          "type": "simple"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "Headers",
+            "value": "headers"
+          },
+          {
+            "name": "Query parameters",
+            "value": "query"
+          }
+        ]
+      },
+      {
+        "id": "authentication.name",
+        "label": "API key name",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.name",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "apiKey",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.value",
+        "label": "API key value",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.value",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "apiKey",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.username",
+        "label": "Username",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.username",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "basic",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.password",
+        "label": "Password",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.password",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "basic",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.token",
+        "label": "Bearer token",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.token",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "bearer",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.oauthTokenEndpoint",
+        "label": "OAuth 2.0 token endpoint",
+        "description": "The OAuth token endpoint",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true,
+          "pattern": {
+            "value": "^(=|(http://|https://|secrets|\\{\\{).*$)",
+            "message": "Must be a http(s) URL"
+          }
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.oauthTokenEndpoint",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "oauth-client-credentials-flow",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.clientId",
+        "label": "Client ID",
+        "description": "Your application's client ID from the OAuth client",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.clientId",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "oauth-client-credentials-flow",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.clientSecret",
+        "label": "Client secret",
+        "description": "Your application's client secret from the OAuth client",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.clientSecret",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "oauth-client-credentials-flow",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.audience",
+        "label": "Audience",
+        "description": "The unique identifier of the target API you want to access",
+        "optional": true,
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.audience",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "oauth-client-credentials-flow",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.clientAuthentication",
+        "label": "Client authentication",
+        "description": "Send client ID and client secret as Basic Auth request in the header, or as client credentials in the request body",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.clientAuthentication",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "oauth-client-credentials-flow",
+          "type": "simple"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "Send client credentials in body",
+            "value": "credentialsBody"
+          },
+          {
+            "name": "Send as Basic Auth header",
+            "value": "basicAuthHeader"
+          }
+        ]
+      },
+      {
+        "id": "authentication.scopes",
+        "label": "Scopes",
+        "description": "The scopes which you want to request authorization for (e.g.read:contacts)",
+        "optional": true,
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.scopes",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "oauth-client-credentials-flow",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "method",
+        "label": "Method",
+        "optional": false,
+        "value": "GET",
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "endpoint",
+        "binding": {
+          "name": "method",
+          "type": "zeebe:property"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "POST",
+            "value": "POST"
+          },
+          {
+            "name": "GET",
+            "value": "GET"
+          },
+          {
+            "name": "DELETE",
+            "value": "DELETE"
+          },
+          {
+            "name": "PATCH",
+            "value": "PATCH"
+          },
+          {
+            "name": "PUT",
+            "value": "PUT"
+          }
+        ]
+      },
+      {
+        "id": "url",
+        "label": "URL",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true,
+          "pattern": {
+            "value": "^(=|(http://|https://|secrets|\\{\\{).*$)",
+            "message": "Must be a http(s) URL"
+          }
+        },
+        "feel": "optional",
+        "group": "endpoint",
+        "binding": {
+          "name": "url",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "queryParameters",
+        "label": "Query parameters",
+        "description": "Map of query parameters to add to the request URL",
+        "optional": true,
+        "feel": "required",
+        "group": "endpoint",
+        "binding": {
+          "name": "queryParameters",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "headers",
+        "label": "Headers",
+        "description": "Map of HTTP headers to add to the request",
+        "optional": true,
+        "feel": "required",
+        "group": "endpoint",
+        "binding": {
+          "name": "headers",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "skipEncoding",
+        "label": "Skip URL encoding",
+        "description": "Skip the default URL decoding and encoding behavior",
+        "optional": true,
+        "group": "endpoint",
+        "binding": {
+          "name": "skipEncoding",
+          "type": "zeebe:property"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "httpRequestInterval",
+        "label": "Http request interval",
+        "description": "The delay between HTTP requests, defined as ISO 8601 durations format. <a href='https://docs.camunda.io/docs/components/modeler/bpmn/timer-events/#time-duration' target='_blank'>How to configure a time duration</a>",
+        "optional": false,
+        "value": "PT50S",
+        "feel": "optional",
+        "group": "interval",
+        "binding": {
+          "name": "httpRequestInterval",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "processPollingInterval",
+        "label": "Process polling interval",
+        "optional": false,
+        "value": "PT5S",
+        "group": "interval",
+        "binding": {
+          "name": "processPollingInterval",
+          "type": "zeebe:property"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "connectionTimeoutInSeconds",
+        "label": "Connection timeout in seconds",
+        "description": "Defines the connection timeout in seconds, or 0 for an infinite timeout",
+        "optional": false,
+        "value": "20",
+        "constraints": {
+          "notEmpty": true,
+          "pattern": {
+            "value": "^\\d+$",
+            "message": "Must be a number"
+          }
+        },
+        "feel": "optional",
+        "group": "timeout",
+        "binding": {
+          "name": "connectionTimeoutInSeconds",
+          "type": "zeebe:property"
+        },
+        "tooltip": "Set the timeout in seconds to establish a connection or 0 for an infinite timeout",
+        "type": "String"
+      },
+      {
+        "id": "readTimeoutInSeconds",
+        "label": "Read timeout in seconds",
+        "description": "Timeout in seconds to read data from an established connection or 0 for an infinite timeout",
+        "optional": false,
+        "value": "20",
+        "constraints": {
+          "notEmpty": true,
+          "pattern": {
+            "value": "^\\d+$",
+            "message": "Must be a number"
+          }
+        },
+        "feel": "optional",
+        "group": "timeout",
+        "binding": {
+          "name": "readTimeoutInSeconds",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "activationCondition",
+        "label": "Activation condition",
+        "description": "Condition under which the Connector triggers. Leave empty to catch all events",
+        "optional": true,
+        "feel": "required",
+        "group": "activation",
+        "binding": {
+          "name": "activationCondition",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "correlationKeyProcess",
+        "label": "Correlation key (process)",
+        "description": "Sets up the correlation key from process variables",
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "required",
+        "group": "correlation",
+        "binding": {
+          "name": "correlationKey",
+          "type": "bpmn:Message#zeebe:subscription#property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "correlationKeyPayload",
+        "label": "Correlation key (payload)",
+        "description": "Extracts the correlation key from the incoming message payload",
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "required",
+        "group": "correlation",
+        "binding": {
+          "name": "correlationKeyExpression",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "messageIdExpression",
+        "label": "Message ID expression",
+        "description": "Expression to extract unique identifier of a message",
+        "optional": true,
+        "feel": "required",
+        "group": "correlation",
+        "binding": {
+          "name": "messageIdExpression",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "messageTtl",
+        "label": "Message TTL",
+        "description": "Time-to-live for the message in the broker (ISO-8601 duration)",
+        "optional": true,
+        "constraints": {
+          "notEmpty": false,
+          "pattern": {
+            "value": "^(PT.*|)$",
+            "message": "must be an ISO-8601 duration"
+          }
+        },
+        "feel": "optional",
+        "group": "correlation",
+        "binding": {
+          "name": "messageTtl",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "messageNameUuid",
+        "generatedValue": {
+          "type": "uuid"
+        },
+        "group": "correlation",
+        "binding": {
+          "name": "name",
+          "type": "bpmn:Message#property"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "resultVariable",
+        "label": "Result variable",
+        "description": "Name of variable to store the response in",
+        "group": "output",
+        "binding": {
+          "name": "resultVariable",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "resultExpression",
+        "label": "Result expression",
+        "description": "Expression to map the response into process variables",
+        "feel": "required",
+        "group": "output",
+        "binding": {
+          "name": "resultExpression",
+          "type": "zeebe:property"
+        },
+        "type": "Text"
+      }
+    ],
+    "icon": {
+      "contents": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0nMS4wJz8+Cjxzdmcgd2lkdGg9JzE4JyBoZWlnaHQ9JzE4JyB4bWxucz0naHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmcnPgogICAgPGcgY2xhc3M9J2xheWVyJz4KICAgICAgICA8dGl0bGU+TGF5ZXIgMTwvdGl0bGU+CiAgICAgICAgPHBhdGggZD0nbTE3LjAzLDljMCw0LjQ1IC0zLjYsOC4wNSAtOC4wNSw4LjA1Yy00LjQ1LDAgLTguMDUsLTMuNiAtOC4wNSwtOC4wNWMwLC00LjQ1IDMuNiwtOC4wNSA4LjA1LC04LjA1YzQuNDUsMCA4LjA1LDMuNiA4LjA1LDguMDV6JwogICAgICAgICAgICAgIGZpbGw9JyM1MDU1NjInIGlkPSdzdmdfMScvPgogICAgICAgIDxwYXRoIGQ9J200LjkzLDE0LjE2bDEuODUsLTEwLjQ1bDMuMzYsMGMxLjA1LDAgMS44NCwwLjI3IDIuMzcsMC44MWMwLjU0LDAuNTMgMC44LDEuMjEgMC44LDIuMDZjMCwwLjg2IC0wLjI0LDEuNTggLTAuNzMsMi4xM2MtMC40NywwLjU1IC0xLjEyLDAuOTMgLTEuOTUsMS4xNGwtMC40OCwwLjA5bC0wLjUzLDAuMDNsLTAuNiwwLjA1bC0xLjc5LDBsLTAuNzMsNC4xNGwtMS41OCwwem0yLjU3LC01LjU3bDEuNzQsMGMwLjc2LDAgMS4zNSwtMC4xNyAxLjc4LC0wLjVjMC40NCwtMC4zNSAwLjY1LC0wLjgyIDAuNjUsLTEuNDJjMCwtMC40OCAtMC4xNSwtMC44NSAtMC40NCwtMS4xMmMtMC4zLC0wLjI4IC0wLjc3LC0wLjQyIC0xLjQyLC0wLjQybC0xLjcsMGwtMC42MSwzLjQ2eicKICAgICAgICAgICAgICBmaWxsPSd3aGl0ZScgaWQ9J3N2Z18yJy8+CiAgICA8L2c+Cjwvc3ZnPg=="
+    }
   }
 ]