> For the complete documentation index, see [llms.txt](https://docs.cryptoix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cryptoix.io/developers/webhooks.md).

# Webhooks

Webhooks enable Cryptoix to send real-time notifications to your application when specific events occur within your Cryptoix account. This allows your business to react instantly to payment confirmations, transaction updates, and other critical events without needing to constantly poll our API.

## Understanding Webhooks

Cryptoix utilizes a standard webhook implementation. When a configured event occurs, Cryptoix sends an HTTP POST request containing an event payload to a URL you specify, known as your webhook endpoint. Your application is responsible for receiving, parsing, and acting upon these incoming HTTP requests.

{% stepper %}
{% step %}

### Event Trigger

An action within the Cryptoix platform (e.g., a new payment received) triggers an event.
{% endstep %}

{% step %}

### Notification Dispatch

Cryptoix formats the event data into a JSON payload and sends an HTTP POST request to your registered webhook URL. This dispatch is managed through background job queues or cron tasks to ensure reliability and handle retries.
{% endstep %}

{% step %}

### Endpoint Reception

Your webhook endpoint receives the POST request.
{% endstep %}

{% step %}

### Processing

Your application parses the JSON payload to identify the event type and relevant data.
{% endstep %}

{% step %}

### Action

Your application performs the necessary actions based on the received event data (e.g., updating order status, sending a confirmation email).
{% endstep %}
{% endstepper %}

## Available Webhook Events

Cryptoix supports the following events that can trigger webhook notifications. When an event occurs, Cryptoix will send a POST request to your configured webhook URL with a JSON payload detailing the event.

### `payment_received`

Triggered when a payment is successfully received and confirmed for a transaction.

**Payload Example (Illustrative):**

```json
{
  "event": "payment_received",
  "timestamp": "2023-10-27T10:30:00Z",
  "data": {
    "transaction_id": "txn_123abc456",
    "order_id": "order_xyz789",
    "amount": "1.50",
    "currency": "BTC",
    "status": "paid",
    "payment_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "payment_hash": "a1b2c3d4e5f67890",
    "confirmation_count": 6
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.cryptoix.io/developers/webhooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.