Webhook Receive Task Connector
Configure webhook to receive callbacks
Required inputs
| Key | Label | Type |
|---|---|---|
inbound.context | Webhook ID | string |
inbound.auth.apiKeyLocator | API key locator | secret |
correlationKeyProcess | Correlation key (process) | FEEL expression |
correlationKeyPayload | Correlation key (payload) | FEEL expression |
deduplicationId | Deduplication ID | string |
Optional inputs
| Key | Label | Type |
|---|---|---|
inbound.method | Webhook method | string |
inbound.shouldValidateHmac | HMAC authentication | string |
inbound.hmacSecret | HMAC secret key | secret |
inbound.hmacHeader | HMAC header | FEEL expression |
inbound.hmacAlgorithm | HMAC algorithm | string |
inbound.hmacScopes | HMAC scopes | FEEL expression |
inbound.auth.type | Authorization type | string |
inbound.auth.username | Username | FEEL expression |
inbound.auth.password | Password | secret |
inbound.auth.apiKey | API key | secret |
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 |
inbound.responseExpression | Response expression | FEEL expression |
inbound.verificationExpression | One time verification response expression | FEEL expression |
activationCondition | Activation condition | FEEL expression |
consumeUnmatchedEvents | Consume unmatched events | string |
messageIdExpression | Message ID expression | FEEL expression |
messageTtl | Message TTL | FEEL expression |
deduplicationModeManualFlag | Manual mode | string |
resultVariable | Result variable | string |
resultExpression | Result expression | FEEL expression |
Apply this connector with @bpmnkit/connectors
import { applyConnectorTemplate } from "@bpmnkit/connectors"
const result = applyConnectorTemplate("io.camunda.connectors.webhook.WebhookConnectorReceive.v1", {
"inbound.context": "...",
"inbound.auth.apiKeyLocator": "<your api key locator>",
"correlationKeyProcess": "= ...",
"correlationKeyPayload": "= ...",
"deduplicationId": "...",
"inbound.method": "any",
"inbound.shouldValidateHmac": "enabled",
})