@camunda/connectors-element-templates 1.0.15 → 1.0.17

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

@@ -0,0 +1,654 @@
+[
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "REST Outbound Connector",
+    "id": "io.camunda.connectors.HttpJson.v2",
+    "description": "Invoke REST API",
+    "metadata": {
+      "keywords": []
+    },
+    "documentationRef": "https://docs.camunda.io/docs/components/connectors/protocol/rest/",
+    "version": 12,
+    "category": {
+      "id": "connectors",
+      "name": "Connectors"
+    },
+    "appliesTo": ["bpmn:Task"],
+    "elementType": {
+      "value": "bpmn:ServiceTask"
+    },
+    "engines": {
+      "camunda": "^8.3"
+    },
+    "groups": [
+      {
+        "id": "authentication",
+        "label": "Authentication"
+      },
+      {
+        "id": "endpoint",
+        "label": "HTTP endpoint"
+      },
+      {
+        "id": "timeout",
+        "label": "Connection timeout"
+      },
+      {
+        "id": "payload",
+        "label": "Payload"
+      },
+      {
+        "id": "connector",
+        "label": "Connector"
+      },
+      {
+        "id": "output",
+        "label": "Output mapping"
+      },
+      {
+        "id": "error",
+        "label": "Error handling"
+      },
+      {
+        "id": "retries",
+        "label": "Retries"
+      }
+    ],
+    "properties": [
+      {
+        "value": "io.camunda:http-json:1",
+        "binding": {
+          "property": "type",
+          "type": "zeebe:taskDefinition"
+        },
+        "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:input"
+        },
+        "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:input"
+        },
+        "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
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.name",
+          "type": "zeebe:input"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "apiKey",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.value",
+        "label": "API key value",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.value",
+          "type": "zeebe:input"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "apiKey",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.username",
+        "label": "Username",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.username",
+          "type": "zeebe:input"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "basic",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.password",
+        "label": "Password",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.password",
+          "type": "zeebe:input"
+        },
+        "condition": {
+          "property": "authentication.type",
+          "equals": "basic",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.token",
+        "label": "Bearer token",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.token",
+          "type": "zeebe:input"
+        },
+        "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"
+          }
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.oauthTokenEndpoint",
+          "type": "zeebe:input"
+        },
+        "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
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.clientId",
+          "type": "zeebe:input"
+        },
+        "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
+        },
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.clientSecret",
+          "type": "zeebe:input"
+        },
+        "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,
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.audience",
+          "type": "zeebe:input"
+        },
+        "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:input"
+        },
+        "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,
+        "feel": "optional",
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.scopes",
+          "type": "zeebe:input"
+        },
+        "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:input"
+        },
+        "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:input"
+        },
+        "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:input"
+        },
+        "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:input"
+        },
+        "type": "String"
+      },
+      {
+        "id": "storeResponse",
+        "label": "Store response",
+        "description": "Store the response as a document in the document store",
+        "optional": false,
+        "value": false,
+        "feel": "static",
+        "group": "endpoint",
+        "binding": {
+          "name": "storeResponse",
+          "type": "zeebe:input"
+        },
+        "type": "Boolean"
+      },
+      {
+        "id": "skipEncoding",
+        "label": "Skip URL encoding",
+        "description": "Skip the default URL decoding and encoding behavior",
+        "optional": true,
+        "group": "endpoint",
+        "binding": {
+          "name": "skipEncoding",
+          "type": "zeebe:input"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "followRedirects",
+        "label": "Follow redirects",
+        "description": "If enabled, HTTP 3xx redirects will be followed automatically. Disabled by default.",
+        "optional": false,
+        "value": false,
+        "feel": "static",
+        "group": "endpoint",
+        "binding": {
+          "name": "followRedirects",
+          "type": "zeebe:input"
+        },
+        "type": "Boolean"
+      },
+      {
+        "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": "static",
+        "group": "timeout",
+        "binding": {
+          "name": "connectionTimeoutInSeconds",
+          "type": "zeebe:input"
+        },
+        "type": "Number"
+      },
+      {
+        "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": "static",
+        "group": "timeout",
+        "binding": {
+          "name": "readTimeoutInSeconds",
+          "type": "zeebe:input"
+        },
+        "type": "Number"
+      },
+      {
+        "id": "body",
+        "label": "Request body",
+        "description": "Payload to send with the request",
+        "optional": true,
+        "feel": "optional",
+        "group": "payload",
+        "binding": {
+          "name": "body",
+          "type": "zeebe:input"
+        },
+        "condition": {
+          "property": "method",
+          "oneOf": ["POST", "PUT", "PATCH"],
+          "type": "simple"
+        },
+        "type": "Text"
+      },
+      {
+        "id": "ignoreNullValues",
+        "label": "Ignore null values",
+        "optional": false,
+        "value": false,
+        "feel": "static",
+        "group": "payload",
+        "binding": {
+          "name": "ignoreNullValues",
+          "type": "zeebe:input"
+        },
+        "condition": {
+          "property": "method",
+          "oneOf": ["POST", "PUT", "PATCH"],
+          "type": "simple"
+        },
+        "tooltip": "Null values will not be sent",
+        "type": "Boolean"
+      },
+      {
+        "id": "version",
+        "label": "Version",
+        "description": "Version of the element template",
+        "value": "12",
+        "group": "connector",
+        "binding": {
+          "key": "elementTemplateVersion",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "id",
+        "label": "ID",
+        "description": "ID of the element template",
+        "value": "io.camunda.connectors.HttpJson.v2",
+        "group": "connector",
+        "binding": {
+          "key": "elementTemplateId",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "resultVariable",
+        "label": "Result variable",
+        "description": "Name of variable to store the response in",
+        "group": "output",
+        "binding": {
+          "key": "resultVariable",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "String"
+      },
+      {
+        "id": "resultExpression",
+        "label": "Result expression",
+        "description": "Expression to map the response into process variables",
+        "feel": "required",
+        "group": "output",
+        "binding": {
+          "key": "resultExpression",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "Text"
+      },
+      {
+        "id": "errorExpression",
+        "label": "Error expression",
+        "description": "Expression to handle errors. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/\" target=\"_blank\">documentation</a>.",
+        "feel": "required",
+        "group": "error",
+        "binding": {
+          "key": "errorExpression",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "Text"
+      },
+      {
+        "id": "retryCount",
+        "label": "Retries",
+        "description": "Number of retries",
+        "value": "3",
+        "feel": "optional",
+        "group": "retries",
+        "binding": {
+          "property": "retries",
+          "type": "zeebe:taskDefinition"
+        },
+        "type": "String"
+      },
+      {
+        "id": "retryBackoff",
+        "label": "Retry backoff",
+        "description": "ISO-8601 duration to wait between retries",
+        "value": "PT0S",
+        "group": "retries",
+        "binding": {
+          "key": "retryBackoff",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "String"
+      }
+    ],
+    "icon": {
+      "contents": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTgiIGhlaWdodD0iMTgiIHZpZXdCb3g9IjAgMCAxOCAxOCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4NCjxwYXRoIGQ9Ik0xNy4wMzM1IDguOTk5OTdDMTcuMDMzNSAxMy40NDc1IDEzLjQyODEgMTcuMDUyOSA4Ljk4MDY1IDE3LjA1MjlDNC41MzMxNiAxNy4wNTI5IDAuOTI3NzY1IDEzLjQ0NzUgMC45Mjc3NjUgOC45OTk5N0MwLjkyNzc2NSA0LjU1MjQ4IDQuNTMzMTYgMC45NDcwODMgOC45ODA2NSAwLjk0NzA4M0MxMy40MjgxIDAuOTQ3MDgzIDE3LjAzMzUgNC41NTI0OCAxNy4wMzM1IDguOTk5OTdaIiBmaWxsPSIjNTA1NTYyIi8+DQo8cGF0aCBkPSJNNC45MzEyNiAxNC4xNTcxTDYuNzgxMDYgMy43MTQ3MUgxMC4xMzc1QzExLjE5MTcgMy43MTQ3MSAxMS45ODI0IDMuOTgzMjMgMTIuNTA5NSA0LjUyMDI3QzEzLjA0NjUgNS4wNDczNiAxMy4zMTUgNS43MzM1OCAxMy4zMTUgNi41Nzg5MkMxMy4zMTUgNy40NDQxNCAxMy4wNzE0IDguMTU1MjIgMTIuNTg0MSA4LjcxMjE1QzEyLjEwNjcgOS4yNTkxMyAxMS40NTUzIDkuNjM3MDUgMTAuNjI5OCA5Ljg0NTlMMTIuMDYxOSAxNC4xNTcxSDEwLjMzMTVMOS4wMzM2NCAxMC4wMjQ5SDcuMjQzNTFMNi41MTI1NCAxNC4xNTcxSDQuOTMxMjZaTTcuNDk3MTEgOC41OTI4MUg5LjI0MjQ4QzkuOTk4MzIgOC41OTI4MSAxMC41OTAxIDguNDIzNzQgMTEuMDE3NyA4LjA4NTYxQzExLjQ1NTMgNy43Mzc1MyAxMS42NzQxIDcuMjY1MTMgMTEuNjc0MSA2LjY2ODQyQzExLjY3NDEgNi4xOTEwNiAxMS41MjQ5IDUuODE4MTEgMTEuMjI2NSA1LjU0OTU5QzEwLjkyODIgNS4yNzExMyAxMC40NTU4IDUuMTMxOSA5LjgwOTM2IDUuMTMxOUg4LjEwODc0TDcuNDk3MTEgOC41OTI4MVoiIGZpbGw9IndoaXRlIi8+DQo8L3N2Zz4NCg=="
+    }
+  }
+]