Feature: Webhooks for workflow and task status

community-server/build.gradle

@@ -38,6 +38,7 @@ dependencies {
     implementation project(':task:conductor-kafka')
 
     implementation project(':conductor-workflow-event-listener')
+    implementation project(':conductor-webhook')
 
     implementation 'org.springframework.boot:spring-boot-starter'
     implementation 'org.springframework.boot:spring-boot-starter-validation'

community-server/src/main/resources/application.properties

@@ -127,3 +127,29 @@ management.metrics.export.datadog.enabled=false
 #optional - default Datadog instance is https://app.datadoghq.com/ 
 # management.metrics.export.datadog.uri=<your DD instance>
 #management.metrics.export.datadog.step=10s
+
+# To enable webhook module for TaskStatus and WorkflowStatus notifications
+conductor.workflow-status-listener.type=workflow_publisher
+conductor.task-status-listener.type=task_publisher
+
+# To enable Workflow/Task Summary Input/Output JSON Serialization, use the following:
+conductor.app.summary-input-output-json-serialization.enabled=true
+
+# Webhook Push notification properties
+conductor.webhook.notification.url=
+conductor.webhook.notification.endpointTask=
+#use enums in TaskModel.Status
+conductor.webhook.notification.subscribedTaskStatuses=SCHEDULED,IN_PROGRESS,COMPLETED,CANCELED
+conductor.webhook.notification.endpointWorkflow=
+conductor.webhook.notification.headerDomainGroup=
+conductor.webhook.notification.headerAccountCookie=
+conductor.webhook.notification.headerPrefer=
+conductor.webhook.notification.headerPreferValue=
+conductor.webhook.notification.requestTimeoutMsConnect=100
+conductor.webhook.notification.requestTimeoutMsRead=300
+conductor.webhook.notification.requestTimeoutMsConnMgr=300
+conductor.webhook.notification.requestRetryCount=3
+conductor.webhook.notification.requestRetryIntervalMs=50
+conductor.webhook.notification.connectionPoolMaxRequest=3
+conductor.webhook.notification.connectionPoolMaxRequestPerRoute=3
+

settings.gradle

@@ -25,6 +25,7 @@ include 'index'
 include 'test-util'
 include 'lock'
 include 'workflow-event-listener'
+include 'webhook'
 
 include 'persistence:common-persistence'
 include 'persistence:mysql-persistence'

webhook/README.md

@@ -0,0 +1,16 @@
+# Webhook for publishing workflow and task status changes
+
+WorkflowStatusListener and TaskStatusListener interfaces can be implemented to call webhooks when there is a change in status of workflow and task. We can add new module called 'webhook'.
+
+
+## Published Artifacts
+
+Group: `com.netflix.conductor`
+
+| Published Artifact | Description |
+| ----------- | ----------- | 
+| conductor-webhook | Webhook to publish workflow and task status  |
+
+
+## Configuration
+

webhook/build.gradle

@@ -0,0 +1,24 @@
+plugins {
+    id 'groovy'
+}
+dependencies {
+
+    implementation "com.netflix.conductor:conductor-common:${revConductor}"
+    implementation "com.netflix.conductor:conductor-core:${revConductor}"
+    implementation "com.netflix.conductor:conductor-annotations:${revConductor}"
+    implementation group: 'javax.inject', name: 'javax.inject', version: '1'
+    implementation "org.apache.commons:commons-lang3:"
+    implementation group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.14'
+
+    compileOnly 'org.springframework.boot:spring-boot-starter'
+    compileOnly 'org.springframework.boot:spring-boot-starter-web'
+
+    testImplementation "org.codehaus.groovy:groovy-all:${revGroovy}"
+    testImplementation "org.spockframework:spock-core:${revSpock}"
+    testImplementation "org.spockframework:spock-spring:${revSpock}"
+
+
+    testImplementation "com.netflix.conductor:conductor-server:${revConductor}"
+    testImplementation 'org.springframework.boot:spring-boot-starter-web'
+    testImplementation project(':conductor-test-util').sourceSets.test.output
+}

webhook/dependencies.lock

@@ -0,0 +1,153 @@
+{
+    "annotationProcessor": {
+        "org.springframework.boot:spring-boot-configuration-processor": {
+            "locked": "2.6.7"
+        }
+    },
+    "compileClasspath": {
+        "com.netflix.conductor:conductor-common": {
+            "locked": "3.13.8"
+        },
+        "com.netflix.conductor:conductor-core": {
+            "locked": "3.13.8"
+        },
+        "org.apache.logging.log4j:log4j-api": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-core": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-jul": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-slf4j-impl": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-web": {
+            "locked": "2.17.1"
+        },
+        "org.springframework.boot:spring-boot-starter": {
+            "locked": "2.6.7"
+        },
+        "org.springframework.boot:spring-boot-starter-web": {
+            "locked": "2.6.7"
+        }
+    },
+    "runtimeClasspath": {
+        "com.netflix.conductor:conductor-common": {
+            "locked": "3.13.8"
+        },
+        "com.netflix.conductor:conductor-core": {
+            "locked": "3.13.8"
+        },
+        "org.apache.logging.log4j:log4j-api": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-core": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-jul": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-slf4j-impl": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-web": {
+            "locked": "2.17.1"
+        }
+    },
+    "testCompileClasspath": {
+        "com.netflix.conductor:conductor-common": {
+            "locked": "3.13.8"
+        },
+        "com.netflix.conductor:conductor-core": {
+            "locked": "3.13.8"
+        },
+        "com.netflix.conductor:conductor-server": {
+            "locked": "3.13.8"
+        },
+        "org.apache.logging.log4j:log4j-api": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-core": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-jul": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-slf4j-impl": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-web": {
+            "locked": "2.17.1"
+        },
+        "org.codehaus.groovy:groovy-all": {
+            "locked": "3.0.9"
+        },
+        "org.junit.vintage:junit-vintage-engine": {
+            "locked": "5.8.2"
+        },
+        "org.spockframework:spock-core": {
+            "locked": "2.1-groovy-3.0"
+        },
+        "org.spockframework:spock-spring": {
+            "locked": "2.1-groovy-3.0"
+        },
+        "org.springframework.boot:spring-boot-starter-log4j2": {
+            "locked": "2.6.7"
+        },
+        "org.springframework.boot:spring-boot-starter-test": {
+            "locked": "2.6.7"
+        },
+        "org.springframework.boot:spring-boot-starter-web": {
+            "locked": "2.6.7"
+        }
+    },
+    "testRuntimeClasspath": {
+        "com.netflix.conductor:conductor-common": {
+            "locked": "3.13.8"
+        },
+        "com.netflix.conductor:conductor-core": {
+            "locked": "3.13.8"
+        },
+        "com.netflix.conductor:conductor-server": {
+            "locked": "3.13.8"
+        },
+        "org.apache.logging.log4j:log4j-api": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-core": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-jul": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-slf4j-impl": {
+            "locked": "2.17.1"
+        },
+        "org.apache.logging.log4j:log4j-web": {
+            "locked": "2.17.1"
+        },
+        "org.codehaus.groovy:groovy-all": {
+            "locked": "3.0.9"
+        },
+        "org.junit.vintage:junit-vintage-engine": {
+            "locked": "5.8.2"
+        },
+        "org.spockframework:spock-core": {
+            "locked": "2.1-groovy-3.0"
+        },
+        "org.spockframework:spock-spring": {
+            "locked": "2.1-groovy-3.0"
+        },
+        "org.springframework.boot:spring-boot-starter-log4j2": {
+            "locked": "2.6.7"
+        },
+        "org.springframework.boot:spring-boot-starter-test": {
+            "locked": "2.6.7"
+        },
+        "org.springframework.boot:spring-boot-starter-web": {
+            "locked": "2.6.7"
+        }
+    }
+}