template-connector-message-start-event.json

{
  "$schema" : "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
  "name" : "Template connector (Message Start Event)",
  "id" : "io.camunda.connector.Template.v1:MessageStartEvent",
  "description" : "Describe this connector",
  "metadata" : {
    "keywords" : [ ]
  },
  "documentationRef" : "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview/",
  "version" : 1,
  "category" : {
    "id" : "connectors",
    "name" : "Connectors"
  },
  "appliesTo" : [ "bpmn:StartEvent" ],
  "elementType" : {
    "value" : "bpmn:StartEvent",
    "eventDefinition" : "bpmn:MessageEventDefinition"
  },
  "groups" : [ {
    "id" : "properties",
    "label" : "Properties"
  }, {
    "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:my-inbound-connector:1",
    "binding" : {
      "name" : "inbound.type",
      "type" : "zeebe:property"
    },
    "type" : "Hidden"
  }, {
    "id" : "sender",
    "label" : "Sender",
    "optional" : false,
    "constraints" : {
      "notEmpty" : true
    },
    "feel" : "optional",
    "group" : "properties",
    "binding" : {
      "name" : "sender",
      "type" : "zeebe:property"
    },
    "type" : "String"
  }, {
    "id" : "messagesPerMinute",
    "label" : "Message per minute",
    "optional" : false,
    "feel" : "optional",
    "group" : "properties",
    "binding" : {
      "name" : "messagesPerMinute",
      "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" : "correlationRequired",
    "label" : "Subprocess correlation required",
    "description" : "Indicates whether correlation is required. This is needed for event-based subprocess message start events",
    "value" : "notRequired",
    "group" : "correlation",
    "binding" : {
      "name" : "correlationRequired",
      "type" : "zeebe:property"
    },
    "type" : "Dropdown",
    "choices" : [ {
      "name" : "Correlation not required",
      "value" : "notRequired"
    }, {
      "name" : "Correlation required",
      "value" : "required"
    } ]
  }, {
    "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"
    },
    "condition" : {
      "property" : "correlationRequired",
      "equals" : "required",
      "type" : "simple"
    },
    "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"
    },
    "condition" : {
      "property" : "correlationRequired",
      "equals" : "required",
      "type" : "simple"
    },
    "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" : "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" : "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,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMTgiIHdpZHRoPSIxOCIgdmlld0JveD0iMCAwIDEwIDEwIiBzaGFwZS1yZW5kZXJpbmc9Imdlb21ldHJpY1ByZWNpc2lvbiI+PHRpdGxlPlNsYWNrPC90aXRsZT48ZyBmaWxsPSJub25lIj48cGF0aCBkPSJNMCwwIEwwLDEwIEwxMCwxMCBMMTAsMCB6IiBmaWxsPSIjZWNiMTJmIi8+PC9nPjwvc3ZnPg=="
  }
}