Introduction

This document provides an overview of the user callback mechanism. This mechanism allows a single user or a group of users to be notified via an HTTP endpoint about the status of workflow executions.

Configuration

User callbacks are configured in the system users page. When editing or creating a new user select the Callbacks tab.

Event category

Event category can be one of:

• on_request_success - fired when top workflow instance completes successfully
• on_request_failure - fired when top instance completes with ERROR or FAILED request status
• on_blocking_error - any task (in current or parent instances) has error status

Scope

Scope can be one of:

• user - only the owner user of the workflow execution will be notifies
• group - not implemented
• platform - user will be notified of all workflow execution

Endpoint

Http URL of POST notification.

Payload specification

The body of the post request is in json format and contains the following fields:

• event_id: unique uuid string of notification
• id: instance id
• event: can be one of on_request_success, on_request_failure, on_blocking_error
• status: SUCCESS, ERROR, FAILED
• request: dictionary of the original request

  {
    "body": {},
    "content_type": "",
    "match_info": null,
    "method": "GET",
    "params": {},
    "tail": "test",
    "url": "/api/v01/custom/test"
  }

• errors: list of error strings
• details: it's present only if set callback response node is called. Sample content:

  {"Value": "{"body": "some random string set by callback response node", "status": 200}"}