Set Callback URL

IIMMPACT provides an API endpoint that allows for programmatic configuration of your Callback URL. This method is ideal for automated setups, dynamic URL management, or integration into your own administrative interfaces.

TIP

You can also configure your callback URL from the Dashboard UI.

API Endpoint

POST https://api.iimmpact.com/v2/callback-url

Request Headers

Header	Description	Required
X-Api-Key	Your API key	Yes
X-Timestamp	Unix timestamp in seconds	Yes
X-Nonce	Unique request identifier	Yes
X-Signature	HMAC-SHA256 signature (v1=...)	Yes

See API Key Authentication for how to sign your requests.

Request Parameters (Query String)

INFO

This endpoint accepts parameters as query string parameters, not a JSON request body.

Example: POST /v2/callback-url?url=https://yourdomain.com/webhook&method=POST

Parameter	Type	Required	Description
url	string	Yes	Your callback endpoint URL. Must be a valid absolute HTTP or HTTPS URL
method	string	Yes	HTTP method for the callback: GET or POST

Response 200

Field	Type	Description
data	object	Response data
data.Status	string	Operation result (e.g., Success)
data.CallbackUrl	string	The callback URL that was set
data.Method	string	HTTP method for callbacks: GET or POST
@metadata	object	Response metadata
@metadata.status_code	number	HTTP status code
@metadata.last_updated	string	Timestamp of the response (GMT+8). Format: dd-MM-yyyy HH:mm:ss

Example Response:

{
  "data": {
    "Status": "Success",
    "CallbackUrl": "https://google.com",
    "Method": "POST"
  },
  "@metadata": {
    "status_code": 200,
    "last_updated": "21-05-2025 14:02:56"
  }
}