Events

Inbound

These are the events received via the inbound REST route. It must contain a JSON with the following structure:

{
  "id": "Order1234",
  "stage": "Order Received",
  "value": 88.50
}

• id is the unique id of the process. This can be a string or a number but all events must be of the same type. You cannot report one id as a string and another one as an integer.

• stage is the stage at which the process currently is.

• value is the value you assign to the process. This can be any value you want to be associated with the process. The value has to be a number or integer.

The url to send your events is:

http(s)://hostname:port/api/restrpm/event

Outbound

Outbound events are events generated from the process model. You define through the setup wizard.

• time is the time when the event is sent.

• id (if provided in the event) is always passed as a string value, even when it is a number.

All other field are self explained.

Stage Created

{
  "event":"stagecreated",
  "time":1618403859063,
  "stage":"Order Received"
}

Stage Checkin

{
  "event":"stagecheckin",
  "time":1618403859556,
  "stage":"Shipment Ready",
  "id":"251"
}

Stage Checkout

{
  "event":"stagecheckout",
  "time":1618403919714,
  "stage":"Shipment Pickup",
  "id":"251"
}

Link Created

{
  "event":"linkcreated",
  "time":1618403859558,
  "sourcestage":"Shipment Ready",
  "targetstage":"Shipment Pickup"
}

Link Travel

{
  "event":"linktravel",
  "time":1618403919712,
  "id":"250",
  "sourcestage":"Wait for Product Reorder",
  "targetstage":"Process Order"
}

Alert

{
  "event":"alert",
  "time":1618400677060,
  "stage":"Wait for Product Reorder",
  "id":"126"
}