pfx-event:sendCustom

Allows you to send custom events into PlatformManager in order to trigger workflow.

Properties

Option

Type

Default

Description

Option

Type

Default

Description

eventType

string

 

Event type of the event to be sent. Must use the upper snake case. Example: MY_DISTRIBUTION_EVENT

inputSource

string

 

Defines the input source for data in exchange. It can be stored in the header, property or body.

inputSourceName

string

 

Defines the input source name for the source type header and property. It is the name of the exchange header or exchange property.

Limitations

There are certain limitations on the format of the event type and on a payload.

Event Type Format Limitation

The event type must follow the UPPER_SNAKE_CASE definition.

It cannot, under no circumstances, contain a dot (.), otherwise the event would not be delivered.

Payload Limitation

Payload must be a valid JSON object or an object that can be represented as a JSON object.

JSON arrays or data structures that will be converted into JSON arrays are not supported.

Valid definitions:

  • Valid json object, e.g.

    { "attr1": "21", "attr2": "3", "attr3": { "inner1": true, "inner2": {}, "inner3": [] } }

     

  • Object structure that can be represented in JSON object, e.g.:

    Map.of("attr1", "val1") -> {"attr1":"val1"} [:] -> {} [attr1:"val1"] -> {"attr1":"val1"} [attr1:[]] -> {"attr1":[]}

What the payload cannot look like:

[] -> json array [{},{}] -> json array of objects List.of() -> java list ["1","2","3"] -> groovy list

Examples

Send the event MY_DISTRIBUTION_EVENT with a payload:

You can then work with the payload in PlatformManager.

 

Send the event MY_EVENT with a payload as an object:

IntegrationManager version 5.8.0