Webhook Events

We use webhooks to notify you about important events on your Invoice APIs. These webhooks contain details about the event such as changes that occurred and the resources impacted by the change.

We send webhooks as HTTP POST call to a URL configured by you. The webhook payload uses the JSON format.

Learn more about our Webhooks.

Available Events

The table below lists the various webhook events triggered when verifying Aadhaar via OTP.

Webhook Events	Description
bharat_connect.invoice.create	Triggered when the Send Invoice Request API call is successfully made.
bharat_connect.invoice.confirm	Triggered when the Confirm Invoice Request API call is successfully made.
bharat_connect.invoice.change_status	Triggered when the Change Invoice status Request API call is successfully made.
bharat_connect.invoice.change_status	Triggered when the Edit Invoice Request API call is successfully made.

Sample Payload

Send Invoice Request

Triggered when the Check Business API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.invoice.create",
    "is_sandbox": true,
    "data": {
	{
    "id": "bcinv_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.invoice",
    "type": "OUTGOING",
    "supplier_invoice_number": "INV0012312",
    "supplier_details": {
        "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
        "gst_in": "22AAAAA0000A3Z9",
        "legal_name": "Open Financial",
        "trade_name": "Open Financial",
        "email": "[email protected]",
        "state_code": "32",
        "place_of_supply_code": "",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 123",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "buyer_details": {
        "b2b_id": "zwch_1731046715a8b539acf65f6707494305",
        "gst_in": "22AAAAA0000A1H2",
        "legal_name": "Surjava Test",
        "trade_name": "Surjava Test",
        "email": "[email protected]",
        "state_code": "06",
        "place_of_supply_code": "32",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 456",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "transaction_detais": {
        "supply_type": "B2B",
        "reverse_charge_tax": "",
        "e_commerce_gstin": "",
        "igst_chargable": ""
    },
    "e_invoice_details": {
        "irn": "",
        "irn_ts": ""
    },
    "items_details": [
        {
            "serial_no": "1",
            "is_service": "NO",
            "hsn_code": "19059040",
            "quantity": 1,
            "unit_price": 2,
            "total_amount": 2,
            "assessment_amount": 2,
            "gst_rate": 18,
            "total_item_value": 4,
            "product_description": "xyz description test"
        }
    ],
    "value_details": {
        "assessment_value": 4,
        "total_invoice_value": 4
    },
    "supplier_bank_details": {
        "vpa": "test@vpa",
        "account_type": "",
        "bank_account_number": "3307",
        "name_of_account_holder": "John Doe",
        "bank_ifsc_code": "SBIN0070305",
        "bank_name": "SBI"
    },
    "metadata": {},
    "status": "SENT TO BUYER",
    "response":{
	    "status":"SUCCESS",
	    "message":""
    }

}

    }
}

Confirm Invoice Request

Triggered when the Confirm Invoice Request API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.invoice.confirm",
    "is_sandbox": true,
    "data": {
	{
    "id": "bcinv_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.invoice.",
    "type": "INCOMING"
    "supplier_invoice_number": "INV0012312",
    "supplier_details": {
        "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
        "gst_in": "22AAAAA0000A3Z9",
        "legal_name": "Open Financial",
        "trade_name": "Open Financial",
        "email": "[email protected]",
        "state_code": "32",
        "place_of_supply_code": "",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 123",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "buyer_details": {
        "b2b_id": "zwch_1731046715a8b539acf65f6707494305",
        "gst_in": "22AAAAA0000A1H2",
        "legal_name": "Surjava Test",
        "trade_name": "Surjava Test",
        "email": "[email protected]",
        "state_code": "06",
        "place_of_supply_code": "32",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 456",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "transaction_detais": {
        "supply_type": "B2B",
        "reverse_charge_tax": "",
        "e_commerce_gstin": "",
        "igst_chargable": ""
    },
    "e_invoice_details": {
        "irn": "",
        "irn_ts": ""
    },
    "items_details": [
        {
            "serial_no": "1",
            "is_service": "NO",
            "hsn_code": "19059040",
            "quantity": 1,
            "unit_price": 2,
            "total_amount": 2,
            "assessment_amount": 2,
            "gst_rate": 18,
            "total_item_value": 4,
            "product_description": "xyz description test"
        }
    ],
    "value_details": {
        "assessment_value": 4,
        "total_invoice_value": 4
    },
    "supplier_bank_details": {
        "vpa": "test@vpa",
        "account_type": "",
        "bank_account_number": "3307",
        "name_of_account_holder": "John Doe",
        "bank_ifsc_code": "SBIN0070305",
        "bank_name": "SBI"
    },
    "metadata": {},
    "status": "ACCEPTED",
    "response":{
	    "status":"SUCCESS",
	    "message":""
    }
}

    }
}

Change Invoice status Request

Triggered when the Change Invoice status Request API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.invoice.change_status",
    "is_sandbox": true,
    "data": {
	{
    "id": "bcinv_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.invoice",
    "type": "OUTGOING"
    "supplier_invoice_number": "INV0012312",
    "supplier_details": {
        "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
        "gst_in": "22AAAAA0000A3Z9",
        "legal_name": "Open Financial",
        "trade_name": "Open Financial",
        "email": "[email protected]",
        "state_code": "32",
        "place_of_supply_code": "",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 123",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "buyer_details": {
        "b2b_id": "zwch_1731046715a8b539acf65f6707494305",
        "gst_in": "22AAAAA0000A1H2",
        "legal_name": "Surjava Test",
        "trade_name": "Surjava Test",
        "email": "[email protected]",
        "state_code": "06",
        "place_of_supply_code": "32",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 456",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "transaction_detais": {
        "supply_type": "B2B",
        "reverse_charge_tax": "",
        "e_commerce_gstin": "",
        "igst_chargable": ""
    },
    "e_invoice_details": {
        "irn": "",
        "irn_ts": ""
    },
    "items_details": [
        {
            "serial_no": "1",
            "is_service": "NO",
            "hsn_code": "19059040",
            "quantity": 1,
            "unit_price": 2,
            "total_amount": 2,
            "assessment_amount": 2,
            "gst_rate": 18,
            "total_item_value": 4,
            "product_description": "xyz description test"
        }
    ],
    "value_details": {
        "assessment_value": 4,
        "total_invoice_value": 4
    },
    "supplier_bank_details": {
        "vpa": "test@vpa",
        "account_type": "",
        "bank_account_number": "3307",
        "name_of_account_holder": "John Doe",
        "bank_ifsc_code": "SBIN0070305",
        "bank_name": "SBI"
    },
    "metadata": {},
    "status": "CLOSED",
    "response":{
	    "status":"SUCCESS",
	    "message":""
    }
}

    }
}

Edit Invoice Request

Triggered when the Edit Invoice Request API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.invoice.edit",
    "is_sandbox": true,
    "data": {
	{
    "id": "bcinv_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.invoice",
    "supplier_invoice_number": "INV0012312",
    "supplier_details": {
        "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
        "gst_in": "22AAAAA0000A3Z9",
        "legal_name": "Open Financial",
        "trade_name": "Open Financial",
        "email": "[email protected]",
        "state_code": "32",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 123",
            "city": "Bangalore",
            "postal_code": "560035",
            "state": "KARNATAKA"
        },
        "mobile_number":""
    },
    "buyer_details": {
        "b2b_id": "zwch_1731046715a8b539acf65f6707494305",
        "gst_in": "22AAAAA0000A1H2",
        "legal_name": "Surjava Test",
        "trade_name": "Surjava Test",
        "email": "[email protected]",
        "state_code": "06",
        "place_of_supply_code": "32",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 456",
            "city": "Bangalore",
            "postal_code": "560035",
            "state": "KARNATAKA"
        }
    },
    "transaction_details": {
        "supply_type": "B2B",
        "reverse_charge_tax": "",
        "e_commerce_gstin": "",
        "igst_chargable": ""
    },
    "e_invoice_details": {
        "irn": "",
        "irn_ts": ""
    },
    "items_details": [
        {
            "serial_no": "1",
            "is_service": "NO",
            "hsn_code": "19059040",
            "quantity": 1.0,
            "unit_price": 2.0,
            "total_amount": 2.0,
            "assessment_amount": 2.0,
            "gst_rate": 18.0,
            "total_item_value": 4.0,
            "product_description": "xyz description test"
        }
    ],
    "supplier_bank_details": {
        "vpa": "test@vpa",
        "bank_account_number": "3307",
        "name_of_account_holder": "John Doe",
        "bank_ifsc_code": "SBIN0070305",
        "bank_name": "SBI"
    },
    "metadata": {},
    "response":{
	    "status":"SUCCESS",
	    "message":""
    }
}

    }
}