Home / Connectors / Webhook Message Start Event Connector

Webhook Message Start Event Connector

Configure webhook to receive callbacks

inbound-start

Required inputs

KeyLabelType
inbound.context Webhook ID string
inbound.auth.username Username FEEL expression
inbound.auth.password Password secret
inbound.auth.apiKey API Key secret
inbound.auth.apiKeyLocator API Key locator secret
Correlation key (process) FEEL expression
correlationKeyExpression Correlation key (payload) FEEL expression

Optional inputs

KeyLabelType
webhookMethod Webhook method string
shouldValidateHmac HMAC authentication string
inbound.hmacSecret HMAC secret key secret
inbound.hmacHeader HMAC header string
inbound.hmacAlgorithm HMAC algorithm string
inbound.hmacScopes HMAC scopes FEEL expression
authorizationType Authorization type string
inbound.auth.jwt.jwkUrl JWK url FEEL expression
inbound.auth.jwt.permissionsExpression JWT role property expression FEEL expression
inbound.auth.jwt.requiredPermissions Required roles FEEL expression
messageIdExpression Message ID expression FEEL expression
activationCondition Condition FEEL expression
correlationRequired Correlation required string
resultVariable Result variable string
resultExpression Result expression FEEL expression
inbound.responseBodyExpression Response body expression FEEL expression

Apply this connector with @bpmnkit/connectors

import { applyConnectorTemplate } from "@bpmnkit/connectors" const result = applyConnectorTemplate("io.camunda.connectors.webhook.WebhookConnectorStartMessage.v1", { "inbound.context": "...", "inbound.auth.username": "= ...", "inbound.auth.password": "<your password>", "inbound.auth.apiKey": "<your api key>", "inbound.auth.apiKeyLocator": "<your api key locator>", "": "= ...", "correlationKeyExpression": "= ...", "webhookMethod": "any", "shouldValidateHmac": "enabled", })