# Web Poller

### What is the Web Poller in ZigiOps?

The **Web Poller** is a generic ZigiOps connector designed to retrieve data from external web endpoints using scheduled HTTP requests.

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

* Systems that expose REST APIs but are not natively supported
* Internal custom-built applications
* Middleware APIs
* Legacy platforms with HTTP endpoints
* Data aggregation services

The Web Poller works in a **pull-based model** - ZigiOps periodically polls the configured endpoint, retrieves the response, extracts the relevant records, and processes them within an integration workflow.

The Web Poller:

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

### When should I use the Web Poller?

Use the Web Poller when:

* The external system exposes a REST endpoint
* The integration must be pull-based (not event-driven)
* You need scheduled synchronization
* The system cannot send webhooks
* You are integrating with 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 Poller, ensure:

* The endpoint is reachable from the ZigiOps host
* Required ports are open
* Authentication credentials are available (if required)
* The endpoint returns structured JSON or XML data

There are no version requirements for the Web Poller.

### How does the Web Poller work?

1. ZigiOps sends an HTTP request to the configured URL.
2. The endpoint returns a response payload.
3. ZigiOps extracts the desired records using the defined document path.
4. Extracted data is mapped within the integration workflow.
5. Records are synchronized to the target system.

This process runs based on the configured polling schedule.

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

#### Web Poller - Connected System Configuration

Follow the steps below to add Web Poller as a connected system.

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

{% step %}
Navigate to **Connected Systems > Add New System > Web Poller**.
{% endstep %}

{% step %}
Configure the following parameters:

**URL**\
Input the URL and port number of the web endpoint that returns the required response.\
Example: `https://api.example.com:8080/events`

**Document Extract Path**\
Specify the path to the desired record(s) within the request body.\
Example: `parentItem/childItem`

This parameter determines which portion of the JSON/XML payload will be processed as individual records.

**Timestamp Format for Schema**\
Define the endpoint's timestamp format. This ensures correct parsing and schema alignment during synchronization.

**Authentication**\
Select **Basic** authentication if required.

If Basic authentication is selected:

* **Username** - Input the username required for authentication.
* **Password** - Input the password required for authentication.
  {% endstep %}

{% step %}
Examine the settings.
{% endstep %}

{% step %}
Click **Save** to store the system.

Once saved, the Web Poller becomes available for use within integration configurations.
{% endstep %}
{% endstepper %}

### Web Poller use case scenarios

#### Use case 1: Pulling events from a custom internal API

An internal application exposes operational events via REST. ZigiOps polls the endpoint every few minutes and synchronizes events into an ITSM platform.

#### Use case 2: Integrating a non-supported monitoring tool

A monitoring solution provides a REST endpoint but does not support outbound webhooks. Web Poller periodically retrieves alerts and forwards them to an event management system.

#### Use case 3: Scheduled data synchronization

A third-party system provides periodic batch updates via API. ZigiOps polls the endpoint on a schedule and synchronizes new records.

#### Use case 4: Middleware data aggregation

An enterprise middleware aggregates multiple data sources into a unified API. Web Poller retrieves the aggregated data and distributes it to multiple downstream systems.

### Limitations and scope

The Web Poller:

* Does not validate external API schemas automatically
* Does not enforce version compatibility
* Does not provide prebuilt templates
* Requires proper document path configuration
* Operates only in a pull-based model

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

### Summary

The Web Poller in ZigiOps provides:

* Generic HTTP pull-based integration
* REST endpoint connectivity
* Configurable document extraction
* Support for Basic authentication
* Flexible schema-based mapping

It is ideal for integrating unsupported, internal, or custom-built systems that expose HTTP APIs.


---

# 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-poller.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.