SteveSteve

Get workflow job status

GET/api/v1/jobs/{sessionId}

Authorization

AuthorizationRequiredBearer <token>

Steve API key, usually scoped to a company. Legacy keys and keys created by platform administrators may be unscoped; company-scoped endpoints reject unscoped keys with 403 Forbidden. Format: Authorization: Bearer aok_...

In: header

Path Parameters

sessionIdRequiredstring

Steve session identifier.

Header Parameters

X-Request-Idstring

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

Maximum length: 128
curl -X GET "https://your-deployment.convex.site/api/v1/jobs/<string>" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>"

Session job state and current business outcome

{
  "sessionId": "string",
  "submissionId": "string",
  "workflow": {
    "slug": "string",
    "version": 0
  },
  "companyId": "string",
  "state": "pending",
  "submissionStatus": "created",
  "result": null,
  "failedReason": "string",
  "clientSubmissionId": "string",
  "metadata": null,
  "processedAt": "2019-08-24T14:15:22Z",
  "webhookDeliveryStatus": "pending"
}

Previous

Get your company

Next

Test webhook reachability