# Webhook

### What is the Webhook in ZigiOps?

The **Webhook** is a generic ZigiOps connector designed to send outbound HTTP requests to external systems.

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

* Systems that expose REST endpoints but are not natively supported
* Custom-built internal applications
* Middleware platforms
* Event-driven architectures
* Lightweight outbound integrations

The Webhook operates in an **outbound push model** — ZigiOps sends data to an external endpoint whenever an integration event occurs.

The Webhook:

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

### When should I use the Webhook?

Use the Webhook when:

* You need ZigiOps to send data to an external REST endpoint
* The target system supports HTTP POST, PUT, or PATCH
* You are integrating with a custom-built or unsupported platform
* You want real-time outbound notifications
* You are building event-driven integrations

### 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 Webhook, ensure:

* The external endpoint is reachable from the ZigiOps host
* Required outbound ports are open
* Authentication credentials (if required) are available
* The receiving system can process JSON payloads

There are no version requirements for the Webhook connector.

### How does the Webhook work?

1. A defined integration event occurs in ZigiOps.
2. ZigiOps prepares the payload according to the configured schema.
3. ZigiOps sends an HTTP request to the specified endpoint.
4. The receiving system processes the payload.

This enables real-time, event-driven outbound integrations.

### How do I configure the Webhook in ZigiOps?

#### Webhook - Connected System Configuration

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

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

{% step %}
Navigate to Webhook

Navigate to **Connected Systems > Add New System > Webhook**.
{% endstep %}

{% step %}
Configure the parameters

Configure the following parameters:

**Request Method**\
Select the desired HTTP method:

* POST
* PUT
* PATCH

**Data Format**\
Select: `JSON`

**Data Location**\
Input the path to the data location in the payload.\
Example: `root/result`

This defines how the outgoing data is structured.

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

If Basic authentication is selected:

* **Username** — Input the username required to authenticate against the Webhook.
* **Password** — Input the password required to authenticate against the Webhook.
  {% endstep %}

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

{% step %}
Save the system

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

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

### Webhook use case scenarios

#### Use case 1: Sending incident updates to an internal application

When an incident is updated in an ITSM system, ZigiOps sends a JSON payload to an internal application endpoint.

#### Use case 2: Triggering external automation

ZigiOps sends a POST request to an automation platform whenever a monitoring event is created.

#### Use case 3: Integrating with unsupported SaaS platforms

A SaaS application provides a REST endpoint but no official connector. Webhook enables direct outbound communication.

#### Use case 4: Event-driven enterprise architecture

ZigiOps acts as an event publisher, sending structured JSON payloads to a message-processing endpoint.

### Limitations and scope

The Webhook:

* Supports JSON payloads only
* Requires proper data path configuration
* Does not validate external schemas automatically
* Does not provide prebuilt templates
* Operates only in an outbound push model

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

### Summary

The Webhook connector in ZigiOps provides:

* Generic outbound HTTP capability
* Support for POST, PUT, and PATCH methods
* Basic authentication support
* Configurable JSON payload structure
* Flexible integration with unsupported systems

It is ideal for sending integration data to custom, internal, or non-supported external platforms.


---

# 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/webhook.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.