@camunda/connectors-element-templates 1.0.19 → 1.0.21

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

@@ -3,7 +3,7 @@
     "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
     "name": "WhatsApp Business Outbound Connector",
     "id": "io.camunda.connectors.WhatsApp.v1",
-    "version": 3,
+    "version": 5,
     "engines": {
       "camunda": "^8.3"
     },
@@ -31,20 +31,20 @@
     },
     "groups": [
       {
-        "id": "authentication",
-        "label": "Authentication"
+        "id": "operation",
+        "label": "Operation"
       },
       {
-        "id": "endpoint",
-        "label": "HTTP endpoint"
+        "id": "authentication",
+        "label": "Authentication"
       },
       {
         "id": "input",
         "label": "Payload"
       },
       {
-        "id": "timeout",
-        "label": "Connect timeout"
+        "id": "connector",
+        "label": "Connector"
       },
       {
         "id": "output",
@@ -60,12 +60,13 @@
         "type": "Hidden",
         "value": "io.camunda:http-json:1",
         "binding": {
-          "type": "zeebe:taskDefinition:type"
+          "type": "zeebe:taskDefinition",
+          "property": "type"
         }
       },
       {
         "label": "Access token",
-        "description": "Temporary or permanent WhatsApp application access token. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
+        "tooltip": "Temporary or permanent WhatsApp application access token. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>WhatsApp connector documentation</a>",
         "group": "authentication",
         "type": "String",
         "feel": "optional",
@@ -79,7 +80,7 @@
       },
       {
         "label": "Sender phone number ID",
-        "description": "A phone number ID registered in your WhatsApp application. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
+        "tooltip": "A phone number ID registered in your WhatsApp application. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>WhatsApp connector documentation</a>",
         "group": "input",
         "type": "String",
         "feel": "optional",
@@ -93,7 +94,7 @@
       },
       {
         "label": "Recipient phone number",
-        "description": "A phone number that should receive a message. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
+        "tooltip": "A phone number that should receive a message. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>WhatsApp connector documentation</a>",
         "group": "input",
         "type": "String",
         "feel": "optional",
@@ -107,11 +108,11 @@
       },
       {
         "label": "Message type",
-        "description": "Choose message type you wish to send.  <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
-        "group": "input",
+        "tooltip": "Choose whether to send arbitrary plain text or an approved WhatsApp message template. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>WhatsApp connector documentation</a>",
+        "group": "operation",
         "id": "messageType",
         "type": "Dropdown",
-        "value": "messageType",
+        "value": "plainText",
         "choices": [
           {
             "name": "Plain text",
@@ -129,7 +130,7 @@
       },
       {
         "label": "Message text",
-        "description": "Plain text message to be sent to the recipient",
+        "tooltip": "Plain text message to be sent to the recipient",
         "group": "input",
         "type": "Text",
         "feel": "optional",
@@ -147,7 +148,7 @@
       },
       {
         "label": "Template name",
-        "description": "An approved WhatsApp template name",
+        "tooltip": "An approved WhatsApp template name",
         "group": "input",
         "type": "String",
         "feel": "optional",
@@ -165,7 +166,8 @@
       },
       {
         "label": "Template language code",
-        "description": "An approved WhatsApp template language code, e.g. en_US",
+        "placeholder": "en_US",
+        "tooltip": "An approved WhatsApp template language code",
         "group": "input",
         "type": "String",
         "feel": "optional",
@@ -183,7 +185,7 @@
       },
       {
         "label": "Header variables",
-        "description": "Header variables if supported by template",
+        "tooltip": "Values for the header variables, only if the template header uses any",
         "value": "=[]",
         "group": "input",
         "type": "Text",
@@ -203,7 +205,7 @@
       },
       {
         "label": "Body variables",
-        "description": "Body variables if supported by template",
+        "tooltip": "Values for the body variables, only if the template body uses any",
         "value": "=[]",
         "group": "input",
         "type": "Text",
@@ -271,7 +273,7 @@
       },
       {
         "label": "Result variable",
-        "description": "Name of variable to store the response in. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#result-variable\" target=\"_blank\">documentation</a>",
+        "tooltip": "Name of variable to store the response in. <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#result-variable\" target=\"_blank\">result variable documentation</a>",
         "group": "output",
         "type": "String",
         "binding": {
@@ -281,7 +283,7 @@
       },
       {
         "label": "Result expression",
-        "description": "Expression to map the response into process variables. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#result-expression\" target=\"_blank\">documentation</a>",
+        "tooltip": "Expression to map the response into process variables. <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#result-expression\" target=\"_blank\">result expression documentation</a>",
         "group": "output",
         "type": "Text",
         "feel": "required",
@@ -292,7 +294,7 @@
       },
       {
         "label": "Error expression",
-        "description": "Expression to handle errors. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#bpmn-errors\" target=\"_blank\">documentation</a>",
+        "tooltip": "Expression to handle errors. <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#bpmn-errors\" target=\"_blank\">BPMN error handling documentation</a>",
         "group": "errors",
         "type": "Text",
         "feel": "required",
@@ -305,7 +307,7 @@
         "id": "version",
         "label": "Version",
         "description": "Version of the element template",
-        "value": "3",
+        "value": "5",
         "group": "connector",
         "binding": {
           "key": "elementTemplateVersion",
@@ -325,6 +327,46 @@
         },
         "type": "Hidden"
       }
+    ],
+    "steps": [
+      {
+        "name": "Send plain text message",
+        "description": "Send a plain text message to a recipient's phone number via WhatsApp",
+        "keywords": [
+          "send plain text",
+          "text message",
+          "send message",
+          "chat notification",
+          "notify recipient"
+        ],
+        "presetId": "messageType_plainText"
+      },
+      {
+        "name": "Send message template",
+        "description": "Send a pre-approved message template with optional header and body variables via WhatsApp",
+        "keywords": [
+          "send message template",
+          "template message",
+          "approved template",
+          "notification template",
+          "structured message"
+        ],
+        "presetId": "messageType_messageTemplate"
+      }
+    ],
+    "presets": [
+      {
+        "id": "messageType_plainText",
+        "properties": {
+          "messageType": "plainText"
+        }
+      },
+      {
+        "id": "messageType_messageTemplate",
+        "properties": {
+          "messageType": "messageTemplate"
+        }
+      }
     ]
   },
   {
@@ -1218,6 +1260,334 @@
           "key": "errorExpression"
         }
       },
+      {
+        "id": "version",
+        "label": "Version",
+        "description": "Version of the element template",
+        "value": "4",
+        "group": "connector",
+        "binding": {
+          "key": "elementTemplateVersion",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "id",
+        "label": "ID",
+        "description": "ID of the element template",
+        "value": "io.camunda.connectors.WhatsApp.v1",
+        "group": "connector",
+        "binding": {
+          "key": "elementTemplateId",
+          "type": "zeebe:taskHeader"
+        },
+        "type": "Hidden"
+      }
+    ]
+  },
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "WhatsApp Business Outbound Connector",
+    "id": "io.camunda.connectors.WhatsApp.v1",
+    "version": 3,
+    "engines": {
+      "camunda": "^8.3"
+    },
+    "description": "Send messages via WhatsApp",
+    "keywords": [
+      "send message",
+      "send plain text",
+      "send message template",
+      "messaging",
+      "chat",
+      "mobile messaging",
+      "notification"
+    ],
+    "icon": {
+      "contents": "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='18' height='18' viewBox='0 0 175.216 175.552'%3E%3Cdefs%3E%3ClinearGradient id='b' x1='85.915' x2='86.535' y1='32.567' y2='137.092' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='0' stop-color='%2357d163'/%3E%3Cstop offset='1' stop-color='%2323b33a'/%3E%3C/linearGradient%3E%3Cfilter id='a' width='1.115' height='1.114' x='-.057' y='-.057' color-interpolation-filters='sRGB'%3E%3CfeGaussianBlur stdDeviation='3.531'/%3E%3C/filter%3E%3C/defs%3E%3Cpath fill='%23b3b3b3' d='m54.532 138.45 2.235 1.324c9.387 5.571 20.15 8.518 31.126 8.523h.023c33.707 0 61.139-27.426 61.153-61.135.006-16.335-6.349-31.696-17.895-43.251A60.75 60.75 0 0 0 87.94 25.983c-33.733 0-61.166 27.423-61.178 61.13a60.98 60.98 0 0 0 9.349 32.535l1.455 2.312-6.179 22.558zm-40.811 23.544L24.16 123.88c-6.438-11.154-9.825-23.808-9.821-36.772.017-40.556 33.021-73.55 73.578-73.55 19.681.01 38.154 7.669 52.047 21.572s21.537 32.383 21.53 52.037c-.018 40.553-33.027 73.553-73.578 73.553h-.032c-12.313-.005-24.412-3.094-35.159-8.954zm0 0' filter='url(%23a)'/%3E%3Cpath fill='%23fff' d='m12.966 161.238 10.439-38.114a73.42 73.42 0 0 1-9.821-36.772c.017-40.556 33.021-73.55 73.578-73.55 19.681.01 38.154 7.669 52.047 21.572s21.537 32.383 21.53 52.037c-.018 40.553-33.027 73.553-73.578 73.553h-.032c-12.313-.005-24.412-3.094-35.159-8.954z'/%3E%3Cpath fill='url(%23linearGradient1780)' d='M87.184 25.227c-33.733 0-61.166 27.423-61.178 61.13a60.98 60.98 0 0 0 9.349 32.535l1.455 2.312-6.179 22.559 23.146-6.069 2.235 1.324c9.387 5.571 20.15 8.518 31.126 8.524h.023c33.707 0 61.14-27.426 61.153-61.135a60.75 60.75 0 0 0-17.895-43.251 60.75 60.75 0 0 0-43.235-17.929z'/%3E%3Cpath fill='url(%23b)' d='M87.184 25.227c-33.733 0-61.166 27.423-61.178 61.13a60.98 60.98 0 0 0 9.349 32.535l1.455 2.313-6.179 22.558 23.146-6.069 2.235 1.324c9.387 5.571 20.15 8.517 31.126 8.523h.023c33.707 0 61.14-27.426 61.153-61.135a60.75 60.75 0 0 0-17.895-43.251 60.75 60.75 0 0 0-43.235-17.928z'/%3E%3Cpath fill='%23fff' fill-rule='evenodd' d='M68.772 55.603c-1.378-3.061-2.828-3.123-4.137-3.176l-3.524-.043c-1.226 0-3.218.46-4.902 2.3s-6.435 6.287-6.435 15.332 6.588 17.785 7.506 19.013 12.718 20.381 31.405 27.75c15.529 6.124 18.689 4.906 22.061 4.6s10.877-4.447 12.408-8.74 1.532-7.971 1.073-8.74-1.685-1.226-3.525-2.146-10.877-5.367-12.562-5.981-2.91-.919-4.137.921-4.746 5.979-5.819 7.206-2.144 1.381-3.984.462-7.76-2.861-14.784-9.124c-5.465-4.873-9.154-10.891-10.228-12.73s-.114-2.835.808-3.751c.825-.824 1.838-2.147 2.759-3.22s1.224-1.84 1.836-3.065.307-2.301-.153-3.22-4.032-10.011-5.666-13.647'/%3E%3C/svg%3E"
+    },
+    "documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/",
+    "category": {
+      "id": "connectors",
+      "name": "Connectors"
+    },
+    "appliesTo": ["bpmn:Task"],
+    "elementType": {
+      "value": "bpmn:ServiceTask"
+    },
+    "groups": [
+      {
+        "id": "authentication",
+        "label": "Authentication"
+      },
+      {
+        "id": "endpoint",
+        "label": "HTTP endpoint"
+      },
+      {
+        "id": "input",
+        "label": "Payload"
+      },
+      {
+        "id": "timeout",
+        "label": "Connect timeout"
+      },
+      {
+        "id": "output",
+        "label": "Response mapping"
+      },
+      {
+        "id": "errors",
+        "label": "Error handling"
+      }
+    ],
+    "properties": [
+      {
+        "type": "Hidden",
+        "value": "io.camunda:http-json:1",
+        "binding": {
+          "type": "zeebe:taskDefinition:type"
+        }
+      },
+      {
+        "label": "Access token",
+        "description": "Temporary or permanent WhatsApp application access token. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
+        "group": "authentication",
+        "type": "String",
+        "feel": "optional",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "authentication.token"
+        },
+        "constraints": {
+          "notEmpty": true
+        }
+      },
+      {
+        "label": "Sender phone number ID",
+        "description": "A phone number ID registered in your WhatsApp application. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
+        "group": "input",
+        "type": "String",
+        "feel": "optional",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "senderPhoneId"
+        },
+        "constraints": {
+          "notEmpty": true
+        }
+      },
+      {
+        "label": "Recipient phone number",
+        "description": "A phone number that should receive a message. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
+        "group": "input",
+        "type": "String",
+        "feel": "optional",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "recipientPhoneNumber"
+        },
+        "constraints": {
+          "notEmpty": true
+        }
+      },
+      {
+        "label": "Message type",
+        "description": "Choose message type you wish to send.  <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp/' target='_blank'>See documentation</a>",
+        "group": "input",
+        "id": "messageType",
+        "type": "Dropdown",
+        "value": "messageType",
+        "choices": [
+          {
+            "name": "Plain text",
+            "value": "plainText"
+          },
+          {
+            "name": "Message template",
+            "value": "messageTemplate"
+          }
+        ],
+        "binding": {
+          "type": "zeebe:input",
+          "name": "messageType"
+        }
+      },
+      {
+        "label": "Message text",
+        "description": "Plain text message to be sent to the recipient",
+        "group": "input",
+        "type": "Text",
+        "feel": "optional",
+        "constraints": {
+          "notEmpty": true
+        },
+        "binding": {
+          "type": "zeebe:input",
+          "name": "messageBody"
+        },
+        "condition": {
+          "property": "messageType",
+          "equals": "plainText"
+        }
+      },
+      {
+        "label": "Template name",
+        "description": "An approved WhatsApp template name",
+        "group": "input",
+        "type": "String",
+        "feel": "optional",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "templateName"
+        },
+        "constraints": {
+          "notEmpty": true
+        },
+        "condition": {
+          "property": "messageType",
+          "equals": "messageTemplate"
+        }
+      },
+      {
+        "label": "Template language code",
+        "description": "An approved WhatsApp template language code, e.g. en_US",
+        "group": "input",
+        "type": "String",
+        "feel": "optional",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "templateLanguageCode"
+        },
+        "constraints": {
+          "notEmpty": true
+        },
+        "condition": {
+          "property": "messageType",
+          "equals": "messageTemplate"
+        }
+      },
+      {
+        "label": "Header variables",
+        "description": "Header variables if supported by template",
+        "value": "=[]",
+        "group": "input",
+        "type": "Text",
+        "feel": "required",
+        "optional": true,
+        "binding": {
+          "type": "zeebe:input",
+          "name": "headerParameters"
+        },
+        "constraints": {
+          "notEmpty": false
+        },
+        "condition": {
+          "property": "messageType",
+          "equals": "messageTemplate"
+        }
+      },
+      {
+        "label": "Body variables",
+        "description": "Body variables if supported by template",
+        "value": "=[]",
+        "group": "input",
+        "type": "Text",
+        "feel": "required",
+        "optional": true,
+        "binding": {
+          "type": "zeebe:input",
+          "name": "bodyParameters"
+        },
+        "constraints": {
+          "notEmpty": false
+        },
+        "condition": {
+          "property": "messageType",
+          "equals": "messageTemplate"
+        }
+      },
+      {
+        "value": "bearer",
+        "type": "Hidden",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "authentication.type"
+        }
+      },
+      {
+        "type": "Hidden",
+        "value": "post",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "method"
+        }
+      },
+      {
+        "type": "Hidden",
+        "value": "=\"https://graph.facebook.com/v17.0/\"+senderPhoneId+\"/messages\"",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "url"
+        }
+      },
+      {
+        "type": "Hidden",
+        "value": "={\"messaging_product\":\"whatsapp\",\"recipient_type\":\"individual\",\"to\":recipientPhoneNumber,\"type\":\"text\", \"text\":{\"preview_url\":false, \"body\":messageBody}}",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "body"
+        },
+        "condition": {
+          "property": "messageType",
+          "equals": "plainText"
+        }
+      },
+      {
+        "type": "Hidden",
+        "value": "={\"messaging_product\":\"whatsapp\",\"recipient_type\":\"individual\",\"to\":recipientPhoneNumber,\"type\":\"template\", \"template\": {\"name\":templateName, \"language\": { \"code\": templateLanguageCode}, \"components\":[{\"type\":\"header\", \"parameters\":headerParameters}, {\"type\":\"body\", \"parameters\":bodyParameters}]}}",
+        "binding": {
+          "type": "zeebe:input",
+          "name": "body"
+        },
+        "condition": {
+          "property": "messageType",
+          "equals": "messageTemplate"
+        }
+      },
+      {
+        "label": "Result variable",
+        "description": "Name of variable to store the response in. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#result-variable\" target=\"_blank\">documentation</a>",
+        "group": "output",
+        "type": "String",
+        "binding": {
+          "type": "zeebe:taskHeader",
+          "key": "resultVariable"
+        }
+      },
+      {
+        "label": "Result expression",
+        "description": "Expression to map the response into process variables. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#result-expression\" target=\"_blank\">documentation</a>",
+        "group": "output",
+        "type": "Text",
+        "feel": "required",
+        "binding": {
+          "type": "zeebe:taskHeader",
+          "key": "resultExpression"
+        }
+      },
+      {
+        "label": "Error expression",
+        "description": "Expression to handle errors. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#bpmn-errors\" target=\"_blank\">documentation</a>",
+        "group": "errors",
+        "type": "Text",
+        "feel": "required",
+        "binding": {
+          "type": "zeebe:taskHeader",
+          "key": "errorExpression"
+        }
+      },
       {
         "id": "version",
         "label": "Version",