Steve API
API Reference

Test webhook reachability

Validates the webhook URL and performs a test POST using a short timeout. Test requests are not signed.

POST
/api/v1/webhooks/test

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired
webhookUrlRequiredstring

Public HTTPS endpoint to test.

Format: "uri"
curl -X POST "https://your-deployment.convex.site/api/v1/webhooks/test" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://integrator.example.com/webhooks/steve"
  }'

The test request completed. Inspect success and the returned statusCode or error.

{
  "success": true,
  "statusCode": 0,
  "error": "string"
}

Previous

List active companies

Next

Invitation API Overview