# Overview

Webhooks are used to notify your server in real-time when payment events occur.

## Overview

When order status changes (e.g., user payment successful), BlockATM sends HTTP POST request to your configured Webhook URL to notify you for processing.

{% hint style="info" %}
**Use Cases**: Webhooks are suitable for backend order processing, automated inventory updates, user notifications, etc. Even if the frontend page is closed, your server can still receive notifications.
{% endhint %}

## How It Works

```mermaid
sequenceDiagram
    participant User as User
    participant Merchant as Merchant System
    participant BlockATM as BlockATM
    participant Blockchain as Blockchain

    User->>Merchant: Place order
    Merchant->>BlockATM: Create order
    User->>Blockchain: Payment
    Blockchain->>BlockATM: Transaction confirmed
    BlockATM->>Merchant: Webhook notification
    Merchant->>User: Order completed
```

## Configuration

1. Login to BlockATM admin dashboard
2. Go to "Cashier" → "Integration"
3. Configure Webhook notification URL
4. Get Webhook Key (for signature verification)

## Request Specification

### Request Headers

| Header                | Description                   | Example          |
| --------------------- | ----------------------------- | ---------------- |
| Content-Type          | Content type                  | application/json |
| BlockATM-Signature-V2 | HMAC-SHA256 signature         | c3109d97...      |
| BlockATM-Request-Time | Unix timestamp (milliseconds) | 1743060268000    |
| BlockATM-Event        | Event type                    | payment / payout |

### Request Format

```http
POST /your-endpoint HTTP/1.1
Host: your-server.com
Content-Type: application/json
BlockATM-Signature-V2: ab3d...
BlockATM-Request-Time: 1743060268000
BlockATM-Event: Payment

{
  "custNo": "evt_123456789",
  "orderNo": "ORD202312345",
  "status": "SUCCESS",
  ...
}
```

## Event Types

| Event   | Description                    | Documentation                                 |
| ------- | ------------------------------ | --------------------------------------------- |
| payment | Collection order status change | [View details →](/webhook/payment-webhook.md) |
| payout  | Payout order status change     | [View details →](/webhook/payout-webhook.md)  |

## Response Handling

```python
from flask import Flask, request

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def handle_webhook():
    signature = request.headers.get('BlockATM-Signature-V2')
    timestamp = request.headers.get('BlockATM-Request-Time')
    event_type = request.headers.get('BlockATM-Event')

    # Verify request
    if not verify_request(signature, timestamp, request.data):
        return "Invalid request", 401

    # Handle event
    if event_type == 'payment':
        handle_payment(request.json)
    elif event_type == 'payout':
        handle_payout(request.json)

    return "OK", 200
```

## Important Notes

{% hint style="warning" %}
**Security and Reliability Requirements**

1. **Use HTTPS**: Ensure your Webhook URL uses HTTPS protocol
2. **Return HTTP 200**: Server must return HTTP 200 to confirm receipt
3. **Idempotent Processing**: The same event may be received multiple times, ensure processing logic is idempotent
4. **Retry Mechanism**: If delivery fails, BlockATM will retry 5 times within 24 hours
   {% endhint %}

## Next Steps

* [View collection events →](/webhook/payment-webhook.md)
* [View payout events →](/webhook/payout-webhook.md)
* [View signature verification →](/webhook/verification.md)


---

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