API product catalogDeveloper Platform, Sandbox & Key Management

Test webhook

Developer Platform, Sandbox & Key Management

POST

/webhooks/{id}/test

Test webhook

Sandbox availablecreateTest

Sends a signed synthetic test.event to the registered webhook URL. Use this to verify connectivity and HMAC signature verification before going live. This operation does not simulate business events such as order fills.

Parameters

idstringpathRequired

Example: wh_abc123

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Response fields

successboolean

eventIdstring

messagestring

webhookIdstring

urlstring

httpStatusinteger | null

HTTP status your endpoint returned.

Response codes

200Test delivery result.

502The registered endpoint could not be reached or returned a non-2xx response.

Request reference

Sandbox available

id Required · path

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/sandbox/v1/partner/webhooks/%7Bid%7D/test

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "eventId": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "webhookId": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "httpStatus": {
      "type": [
        "integer",
        "null"
      ],
      "description": "HTTP status your endpoint returned."
    }
  }
}

curl -X POST 'https://mystocks.africa/api/sandbox/v1/partner/webhooks/%7Bid%7D/test' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID"

GET /webhooks/{id}/deliveries

Partner Settings