# Web Listener

### What is the Web Listener in ZigiOps?

The **Web Listener** is a generic ZigiOps connector designed to receive inbound HTTP requests from external systems.

Unlike officially supported systems (such as Jira, ServiceNow, or monitoring tools), the Web Listener is intended for:

* Systems that can send HTTP POST requests
* Applications that support webhook-style integrations
* Internal custom-built platforms
* Middleware solutions
* Event-driven architectures

The Web Listener operates in a **push-based model** - external systems send data directly to ZigiOps, which then extracts the relevant records and processes them within an integration workflow.

The Web Listener:

* Does not have supported versions
* Does not provide prebuilt templates
* Is schema-driven and fully configurable

### When should I use the Web Listener?

Use the Web Listener when:

* The external system supports outbound webhooks
* The integration must be real-time or near real-time
* Polling is not desirable
* The system cannot be accessed via pull-based APIs
* You are integrating internal or unsupported applications

### Are there any environmental prerequisites?

{% hint style="info" %}
Confirm the prerequisites of the corresponding integration configuration before continuing, as some flows may require additional setup.
{% endhint %}

Before configuring the Web Listener, ensure:

* The ZigiOps host is reachable from the external system
* Required inbound ports are open
* Firewall rules allow HTTP POST requests
* The sending system can deliver structured JSON payloads

There are no version requirements for the Web Listener.

### How does the Web Listener work?

1. ZigiOps exposes an inbound HTTP endpoint.
2. An external system sends a POST request with structured data.
3. ZigiOps parses the incoming JSON payload.
4. The configured document path extracts individual records.
5. Extracted data is mapped and synchronized to the target system.

This enables real-time, event-driven integrations.

### How do I configure the Web Listener in ZigiOps?

{% stepper %}
{% step %}
Log in to ZigiOps

Log in to your **ZigiOps** instance.
{% endstep %}

{% step %}
Navigate to the Web Listener configuration

Navigate to **Connected Systems > Add New System > Generic Web Listener**.
{% endstep %}

{% step %}
Configure the parameters

Configure the following parameters:

**Incoming Data Format**\
Select **JSON** as the incoming data format.

**Document Extract Path**\
Input the path to the desired record(s) within the request body.

Example: `records/items`

This parameter defines which portion of the JSON payload will be processed as individual records.
{% endstep %}

{% step %}
Review and save

Examine the settings.

Click **Save** to store the system.
{% endstep %}
{% endstepper %}

Once saved, the Web Listener becomes available for use within integration workflows.

### Web Listener use case scenarios

#### Use case 1: Receiving monitoring alerts via webhook

A monitoring platform sends alerts via HTTP POST. Web Listener receives the payload and automatically creates incidents in an ITSM system.

#### Use case 2: Integrating custom internal applications

An internal application sends structured JSON events whenever a business action occurs. Web Listener receives the event and synchronizes it to downstream systems.

#### Use case 3: Real-time DevOps event integration

A CI/CD system sends deployment notifications via webhook. ZigiOps processes the incoming payload and updates change records in an ITSM platform.

#### Use case 4: Middleware event gateway

An enterprise service bus forwards events from multiple systems to a centralized endpoint. Web Listener receives and distributes the events to multiple integration flows.

### Limitations and scope

The Web Listener:

* Accepts JSON payloads only
* Requires proper document path configuration
* Does not validate external schema automatically
* Does not provide prebuilt templates
* Operates only in a push-based model

All transformation logic and mapping are defined within the integration configuration.

### Summary

The Web Listener in ZigiOps provides:

* Generic inbound HTTP endpoint capability
* Real-time, push-based integration
* Configurable JSON record extraction
* Schema-driven data processing
* Flexible mapping and synchronization logic

It is ideal for integrating unsupported or custom-built systems that can send structured HTTP requests.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.zigiwave.com/available-systems/web-listener.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.