SteveSteve

Test webhook reachability

POST/api/v1/webhooks/test

Authorization

AuthorizationRequiredBearer <token>

Company-scoped Steve API key. Format: Authorization: Bearer aok_...

In: header

Request Body

application/jsonRequired
webhookUrlRequiredstring
Format: "uri"

Header Parameters

X-Request-Idstring

Optional caller-supplied request identifier. Maximum length is 128 characters.

Maximum length: 128
curl -X POST "https://your-deployment.convex.site/api/v1/webhooks/test" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "http://example.com"
  }'

Webhook target check result

{
  "success": true,
  "statusCode": 0,
  "error": "string",
  "checkedAt": "2019-08-24T14:15:22Z"
}

Previous

Get workflow job status