Test Webhook

Send a test event to verify your webhook configuration.

This endpoint sends a test event to your configured webhook URL, allowing you to verify that:

• Your endpoint is reachable
• Your signature verification is working correctly
• Your endpoint responds appropriately

The test event will include a real HMAC signature that you can verify using your webhook secret.

Test Event Payload

The test event has the following structure:

{
  "event_type": "webhook.test",
  "message": "This is a test webhook event to verify your endpoint configuration."
}

Error Handling

Error Type	Message	When
Webhook not found	The webhook ID doesn’t exist or belongs to a different domain
Webhook is disabled	The webhook exists but is not enabled (enabled: false)

POST /b2b/webhooks/{webhook_id}/test

Test Webhook

cURL

curl --request POST \
  --url https://nexus.kraken.com/b2b/webhooks/{webhook_id}/test \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>'

200

{
  "result": {
    "result": "success",
    "test_id": "550e8400-e29b-41d4-a716-446655440000",
    "payload_sent": "{\"event_type\":\"webhook.test\",\"message\":\"This is a test webhook event to verify your endpoint configuration.\"}",
    "signature_header": "t=1234567890,v1=abc123def456...",
    "http_status": 200,
    "response_body": "OK",
    "error_message": null
  }
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Headers

Payward-Version · enum<string> · default: 2025-04-15

The target version of the Embed API to use. The API version name is based on the date when the API version was released. For example, the API version 2025-04-15 was released on April 15, 2025.

Available options: 2025-04-15

Path Parameters

webhook_id · string · required

Unique identifier for the webhook

Example:

"WHTEST-XXXXX-EXAMPLE"

Response

200

application/json

Test webhook sent (check result for delivery status)

result · object

Show child attributes