Skip to content

Get Callback URL

IIMMPACT provides an API endpoint that allows you to retrieve your currently configured Callback URL. This is useful for verifying your current settings or for systems that need to dynamically check the callback endpoint.

TIP

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

API Endpoint

http
GET https://api.iimmpact.com/v2/callback-url

Request Headers

HeaderDescriptionRequired
X-Api-KeyYour API keyYes
X-TimestampUnix timestamp in secondsYes
X-NonceUnique request identifierYes
X-SignatureHMAC-SHA256 signature (v1=...)Yes

See API Key Authentication for how to sign your requests.

Response 200

FieldTypeDescription
dataobjectResponse data
data.StatusstringOperation result (e.g., Success)
data.CallbackUrlstringThe currently configured callback URL. Empty string if not configured
data.MethodstringHTTP method for callbacks: GET or POST. Empty string if not configured
@metadataobjectResponse metadata
@metadata.status_codenumberHTTP status code
@metadata.last_updatedstringTimestamp of the response (GMT+8). Format: dd-MM-yyyy HH:mm:ss

Example Response:

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

IIMMPACT API Documentation