Skip to main content

Test webhook endpoint

POST 
/api/v1/sdk/stores/:storeId/webhooks/:webhookId/test

This endpoint sends a test webhook event to your configured URL to verify connectivity and configuration. Use this before going live.

Authentication: Requires Private API Key (sk_*) with Administer permission

Test Behavior:
  • Sends immediate webhook POST to your configured URL
    • Uses real webhook signature (HMAC) with your secret
    • Contains sample event data (test data, not real)
    • Returns delivery results synchronously
    • Does NOT count towards delivery statistics
Response Data:
  • Success/failure status
    • HTTP response code from your endpoint
    • Response time in milliseconds
    • Error message if delivery failed
    • Response body (first 500 chars)
Use Cases:
  • Verifying webhook connectivity
    • Testing signature verification logic
    • Debugging webhook configuration
    • Validating endpoint before going live
Important Notes:
  • Test events contain sample data, not real events
    • Your endpoint should respond within 5 seconds
    • Test uses real HMAC signature - verify in your code
    • 2xx response code indicates success
Error Scenarios:
  • 404 NOT FOUND - Webhook or store not found (Error code: WEBHOOK_NOT_FOUND or STORE_NOT_FOUND)
    • 400 BAD REQUEST - Invalid test event type (Error code: INVALID_EVENT_TYPE)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - Insufficient permissions (Error code: INSUFFICIENT_PERMISSIONS)

Request​

Responses​

Test completed successfully - check result for delivery status