Event API

BPC has an event system to inform clients of certain events to trigger corresponding actions. This API allows to post events that can be received by targeted BPC users.

Method Endpoint

Method	Endpoint
`POST`	`/cxf/bpc-core/event`
Description To send a new event, send a JSON message with the following structure: `{ "topic": "exampleTopic", "data": { "key1": "value1", "key2": "value2" }, "recipients": { "users": [ ... ], "roles": [ "bpcadmin" ], "organizations": [ "virtimo" ] } }` Fields `topic` (required) The topic of the event. `data` (required) The data of the event. `recipients` (optional) The recipients of the event. Users, roles, or organizations can be specified.
Consumes `application/json`
Returns HTTP Status Code `201` : Created `401` : Authentication could not be performed `403` : No access rights `500` : Internal server error
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `EVENT_API_ADMIN` Right : `EVENT_API_SEND`

POST

/cxf/bpc-core/event

Description

To send a new event, send a JSON message with the following structure:

{
    "topic": "exampleTopic",
    "data": {
        "key1": "value1",
        "key2": "value2"
    },
    "recipients": {
        "users": [ ... ],
        "roles": [ "bpcadmin" ],
        "organizations": [ "virtimo" ]
    }
}

Fields

topic (required): The topic of the event.
data (required): The data of the event.
recipients (optional): The recipients of the event. Users, roles, or organizations can be specified.

Consumes

application/json

Returns

HTTP Status Code

201 : Created
401 : Authentication could not be performed
403 : No access rights
500 : Internal server error

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : EVENT_API_ADMIN
Right : EVENT_API_SEND