Workflow status callback

POST

/api/workflow/status

const url = 'https://example.com/api/workflow/status';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"workflowInstanceId":"wf-123","repositoryId":"my-repo","packageName":"spring-2024-update","currentStep":"publish","status":"active","nextActionUrl":"https://engine/api/tasks/456/complete","assignee":{"userName":"user@example.com","displayName":"John Doe","email":"user@example.com"},"comment":"Approved by reviewer","metadata":{"additionalProperty":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workflow/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "workflowInstanceId": "wf-123", "repositoryId": "my-repo", "packageName": "spring-2024-update", "currentStep": "publish", "status": "active", "nextActionUrl": "https://engine/api/tasks/456/complete", "assignee": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "comment": "Approved by reviewer", "metadata": { "additionalProperty": "example" } }'

Callback endpoint for external workflow engines to update workflow status. Typically authenticated via API key header.

Authorizations

bearerAuth

Request Body

application/json

object

workflowInstanceId

required

External workflow engine instance ID

string

Example

wf-123

repositoryId

required

Repository CACHE_ROOT

string

Example

my-repo

packageName

required

Name of the package in the workflow

string

Example

spring-2024-update

currentStep

required

Current step in the workflow

string

Example

publish

status

required

Current workflow status

string

Allowed values: active completed cancelled error

Example

active

nextActionUrl

URL for the next action in external engine

string format: uri

Example

https://engine/api/tasks/456/complete

assignee

object

userName

required

User’s username/login

string

Example

user@example.com

displayName

required

User’s display name

string

Example

John Doe

email

required

User’s email address

string

Example

user@example.com

comment

Comment from external workflow action

string

Example

Approved by reviewer

metadata

Additional metadata from workflow engine

object

key

additional properties

Responses

200

Status update processed successfully

application/json

object

success

required

Whether the status update was processed successfully

boolean

message

Status message

string

error

Error message if the update failed

string

Example

{
  "success": true,
  "message": "Status update processed successfully",
  "error": "Package not found"
}

400

Bad request - validation error or update error

application/json

object

success

required

Whether the status update was processed successfully

boolean

message

Status message

string

error

Error message if the update failed

string

Example

{
  "success": true,
  "message": "Status update processed successfully",
  "error": "Package not found"
}

500

Internal server error

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}