ZE - Webhook Deployment

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: ZE - Webhook Deployment | Zephyr Enterprise Documentation

1 Prerequisite
2 Webhook Service Deployment (Jar): -
3 Webhook Service Deployment (Docker): -

Prerequisite

Install Java 17.
Ensure your Zephyr and Rabbit MQ application is set up and running, For RabbitMq Setup follow the instructions on the following page: https://smartbear.atlassian.net/wiki/spaces/PD/pages/3852992664
[By launching the application in the browser:
- Launch Zephyr with your respective host/domain. Ex: https://test.yourzephyr.com
- Launch RabbitMq with the host and configured port. Ex: http://localhost:15672]
Launch RabbitMq Management in the browser with the host and port (Ex: http://localhost:15672).

Webhook Service Deployment (Jar): -

Create a directory under folder opt “zephyrservice”

mkdir zephyrservice

Download the ze-jira-webhook.jar and copy it under zephyrservice
Create a ze-jira-webhook config file Named “zeJiraWebhook.properties" under folder zephyrservice

vi zeJiraWebhook.properties

Add the below line in the file zeJiraWebhook.properties.

#Webhook Service port
server.port=8081

#context path property
server.servlet.context-path=/webhook

#Rabbitmq config
zephyr.queue.name=ze_queue
zephyr.queue.exchange=ze_exchange
zephyr.queue.routing.key=ze_routing_key

spring.rabbitmq.host=<hostname>
spring.rabbitmq.port=<port>
spring.rabbitmq.username=<username>
spring.rabbitmq.password=<password>

#ze_jira_webhook flags
event.validator.json.file=classpath:webhook-events-validation.json
ze.jira.webhook.event.validation_flag = false

#ssl properties 
#uncomment the below line and add the SSL 
#server.ssl.enabled=true
#server.ssl.key-store-type=PKCS12
#server.ssl.key-alias=<aliasname>
#server.ssl.key-store=file:<path of the certificate>
#server.ssl.key-store-password=<password>

An example of zeJiraWebhook.properties should look like the below: -

Make sure port 8081 is available.
zeJiraWebhook should be able to connect with RabbitMQ.

Open the “Terminal” or “Command Prompt”
Navigate to folder /opt/zephyrservice
Type the below command:

Start the ze-jira-webhook with the following command.

Example command:

Log

The Logs folder will be created where your jars are deployed. Separate log files will be created for each jar. In the above example, it will be in /opt/zephyrservice.