---
title: Webhook Setup
slug: fx/webhook-setup
createdAt: 2026-03-05T02:36:31.087Z
---

A webhook allows your application to receive real‑time notifications when certain events occur. When an event is triggered, our server sends an HTTP POST request to your webhook URL.

### Step 1 - Authorisation

- Please ensure you are have an active [Get Token](docId:-SAjRssjYapsgMWsViWvG)&#x20;

### Step 2 - Create a subscription

- [Create a subscription](docId\:qysNAupIR0LFVhfDnse4g) and select the event that you want notification for.&#x20;

### Step 3 - Receiving a Webhook response

- When an status update to made to the selected event, a webhook response will be sent.&#x20;

Please see example below of a transaction with `"transaction.status"` update from **Open -> Partially Settled -> Settled**

:::CodeblockTabs
Open Status - Response

```json
{
    "transaction": {
        "id": 214122,
        "customer_id": 10040,
        "user_id": 13672,
        "status": "open",
        "status_label": "Open",
        "base_currency": {
            "id": 10004,
            "name": "Australian Dollar",
            "currency_code": "AUD"
        },
        "counter_currency": {
            "id": 10001,
            "name": "US Dollar",
            "currency_code": "USD"
        },
        "base_currency_amount": "150.00",
        "counter_currency_amount": "102.73",
        "receipt_amount": "150.00",
        "receipt_account": {
            "id": 10040,
            "name": "AUD Account",
            "receipt_text": "BSB: 802-985\nAccount Number: 213426618\nPayID: 6H6JB9@monoova.me\n",
            "bank_account": {
                "account_name": "Cymonz Support",
                "account_number": "213426618",
                "pay_id": "6H6JB9@monoova.me",
                "bsb": "802-985"
            }
        },
        "fees": "0.00",
        "payments": [
            {
                "id": 162364,
                "status": "pending",
                "amount": "102.73",
                "fee": "0.00",
                "beneficiary": {
                    "id": 10033,
                    "name": {
                        "first_name": "change",
                        "middle_name": null,
                        "last_name": "change"
                    },
                    "status": "approved_by_client",
                    "country": {
                        "id": 10131,
                        "name": "United States",
                        "country_code": "USA"
                    },
                    "currency": {
                        "id": 10001,
                        "name": "US Dollar",
                        "currency_code": "USD"
                    },
                    "created_date": "2020-12-22T12:09:50+11:00",
                    "updated_date": "2024-06-04T10:18:24+10:00"
                },
                "payment_reference": null,
                "payment_type": null,
                "transaction_reason": {
                    "id": 10451,
                    "name": "Goods Trade"
                },
                "sub_customers": [],
                "created_date": "2026-03-30T20:18:16+11:00",
                "updated_date": "2026-03-30T20:18:16+11:00"
            }
        ],
        "exchange_rate": "0.6849",
        "value_date": "2026-03-31",
        "created_date": "2026-03-30T20:17:57+11:00",
        "updated_date": "2026-03-30T20:18:20+11:00"
    }
}
 
```
:::

:::CodeblockTabs
Partially Settled - response

```json
{
    "transaction": {
        "id": 214122,
        "customer_id": 10040,
        "user_id": 13672,
        "status": "partially_settled",
        "status_label": "Partially Settled",
        "base_currency": {
            "id": 10004,
            "name": "Australian Dollar",
            "currency_code": "AUD"
        },
        "counter_currency": {
            "id": 10001,
            "name": "US Dollar",
            "currency_code": "USD"
        },
        "base_currency_amount": "150.00",
        "counter_currency_amount": "102.73",
        "receipt_amount": "150.00",
        "receipt_account": {
            "id": 10040,
            "name": "AUD Account",
            "receipt_text": "BSB: 802-985\nAccount Number: 213426618\nPayID: 6H6JB9@monoova.me\n",
            "bank_account": {
                "account_name": "Cymonz Support",
                "account_number": "213426618",
                "pay_id": "6H6JB9@monoova.me",
                "bsb": "802-985"
            }
        },
        "fees": "0.00",
        "payments": [
            {
                "id": 162364,
                "status": "pending",
                "amount": "102.73",
                "fee": "0.00",
                "beneficiary": {
                    "id": 10033,
                    "name": {
                        "first_name": "change",
                        "middle_name": null,
                        "last_name": "change"
                    },
                    "status": "approved_by_client",
                    "country": {
                        "id": 10131,
                        "name": "United States",
                        "country_code": "USA"
                    },
                    "currency": {
                        "id": 10001,
                        "name": "US Dollar",
                        "currency_code": "USD"
                    },
                    "created_date": "2020-12-22T12:09:50+11:00",
                    "updated_date": "2024-06-04T10:18:24+10:00"
                },
                "payment_reference": null,
                "payment_type": null,
                "transaction_reason": {
                    "id": 10451,
                    "name": "Goods Trade"
                },
                "sub_customers": [],
                "created_date": "2026-03-30T20:18:16+11:00",
                "updated_date": "2026-03-30T20:18:16+11:00"
            }
        ],
        "exchange_rate": "0.6849",
        "value_date": "2026-03-31",
        "created_date": "2026-03-30T20:17:57+11:00",
        "updated_date": "2026-03-30T20:19:34+11:00"
    }
}
```
:::

:::CodeblockTabs
Settled Status - response

```json
{
    "transaction": {
        "id": 214122,
        "customer_id": 10040,
        "user_id": 13672,
        "status": "settled",
        "status_label": "Settled",
        "base_currency": {
            "id": 10004,
            "name": "Australian Dollar",
            "currency_code": "AUD"
        },
        "counter_currency": {
            "id": 10001,
            "name": "US Dollar",
            "currency_code": "USD"
        },
        "base_currency_amount": "150.00",
        "counter_currency_amount": "102.73",
        "receipt_amount": "150.00",
        "receipt_account": {
            "id": 10040,
            "name": "AUD Account",
            "receipt_text": "BSB: 802-985\nAccount Number: 213426618\nPayID: 6H6JB9@monoova.me\n",
            "bank_account": {
                "account_name": "Cymonz Support",
                "account_number": "213426618",
                "pay_id": "6H6JB9@monoova.me",
                "bsb": "802-985"
            }
        },
        "fees": "0.00",
        "payments": [
            {
                "id": 162364,
                "status": "pending",
                "amount": "102.73",
                "fee": "0.00",
                "beneficiary": {
                    "id": 10033,
                    "name": {
                        "first_name": "change",
                        "middle_name": null,
                        "last_name": "change"
                    },
                    "status": "approved_by_client",
                    "country": {
                        "id": 10131,
                        "name": "United States",
                        "country_code": "USA"
                    },
                    "currency": {
                        "id": 10001,
                        "name": "US Dollar",
                        "currency_code": "USD"
                    },
                    "created_date": "2020-12-22T12:09:50+11:00",
                    "updated_date": "2024-06-04T10:18:24+10:00"
                },
                "payment_reference": null,
                "payment_type": null,
                "transaction_reason": {
                    "id": 10451,
                    "name": "Goods Trade"
                },
                "sub_customers": [],
                "created_date": "2026-03-30T20:18:16+11:00",
                "updated_date": "2026-03-30T20:18:16+11:00"
            }
        ],
        "exchange_rate": "0.6849",
        "value_date": "2026-03-31",
        "created_date": "2026-03-30T20:17:57+11:00",
        "updated_date": "2026-03-30T20:20:09+11:00"
    }
}
```
:::

