An event message key (also known as topic) is a routing key pattern of an event message which is sent after a known event in PIPEFORCE happened and always starts with prefix pipeforce.event, followed by the concrete event type.
...
| Table of Contents | ||
|---|---|---|
|
pipeforce.event.app
This topic group forwards all important events related to app management.
.install.finished
This event message is send after an app was successfully installed.
...
| Code Block |
|---|
pipeforce.event.app.install.finished |
.uninstall.finished
This event message is send after an app was successfully uninstalled.
...
| Code Block |
|---|
pipeforce.event.app.uninstall.finished |
pipeforce.event.iam
This topic group forwards all important events happening inside IAM.
.admin.client.create.client
This event message is send after a new client was created.
...
| Code Block |
|---|
pipeforce.event.iam.admin.client.create.client |
.admin.update.client
This event message is send after a client was updated by an admin.
...
| Code Block |
|---|
pipeforce.event.iam.admin.update.client |
.admin.delete.client.scope.client.mapping
This event message is send after a client scope mapping was deleted.
...
| Code Block |
|---|
pipeforce.event.iam.admin.delete.client.scope.client.mapping |
.admin.create.group
This event message is send after a new group was created.
...
| Code Block |
|---|
pipeforce.event.iam.admin.create.group |
.admin.create.user
This event message is send after a new user was created.
...
| Code Block |
|---|
pipeforce.event.iam.admin.create.user |
.admin.client.create.role
This event message is send after a new role was created.
...
| Code Block |
|---|
pipeforce.event.iam.admin.create.role |
.admin.create.group.membership
This event message is send after a member was added to a group.
...
| Code Block |
|---|
pipeforce.event.iam.admin.create.group.membership |
.admin.create.realm.role.mapping
This event message is send after a resource was mapped to a realm role.
...
| Code Block |
|---|
pipeforce.event.iam.admin.create.realm.role.mapping |
.admin.action.user
This event message is send after a user has done a predefined action.
...
| Code Block |
|---|
pipeforce.event.iam.admin.action.user |
.client.login
This event message is send after an OAuth2 client has been logged-in.
...
| Code Block |
|---|
pipeforce.event.iam.client.login |
.code.to.token
This event message is send after a code has been exchanged to token.
...
| Code Block |
|---|
pipeforce.event.iam.code.to.token |
.login
This event message is send after user has successfully logged-in.
...
| Code Block |
|---|
pipeforce.event.iam.login |
.logout
This event message is send after user has successfully logged-out.
...
| Code Block |
|---|
pipeforce.event.iam.login |
.refresh.token
This event message is send after a token has been refreshed.
...
| Code Block |
|---|
pipeforce.event.iam.refresh.token |
.token.exchange
This event message is send after a token has been exchanged.
...
| Code Block |
|---|
pipeforce.event.iam.token.exchange |
.user.info.request
This event message is send after user information have been requested.
...
| Code Block |
|---|
pipeforce.event.iam.user.info.request |
pipeforce.event.property
This topic group forwards all property events as push notifications.
...
{path} = The path of the related property whereas slashes in path of property will become dots. Dots and special chars in origin path will be replaced by underscores. Everything in path is lower-cased.
.created
This event message is send after a new property was created.
...
| Code Block |
|---|
pipeforce.event.property.created.{path} |
.deleted
This event message is send after a property was deleted.
...
| Code Block |
|---|
pipeforce.event.property.deleted.{path} |
.updated
This event message is send after a property was updated.
...
| Code Block |
|---|
pipeforce.event.property.updated.{path} |
.comment.created
This event message is send after a comment was added to a property.
...
| Code Block |
|---|
pipeforce.event.property.comment.created.{appName} |
.comment.updated
This event message is send after a comment was updated to a property.
...
| Code Block |
|---|
pipeforce.event.property.comment.updated.{appName} |
pipeforce.event.log
This topic group forwards all important log events of severity level WARN or higher.
...
This way you can also listen to events of a certain level and logger type using a pattern. Here is an example which listens for all log levels (warn and above) happening inside the com.logabit package: this for example: pipeforce.event.log.*.com.logabit.#
.error
This event message is send after a new log entry of level ERROR was created.
...
| Code Block |
|---|
pipeforce.event.log.error.{loggerName} |
.warn
This event message is send after a new log entry of level WARN was created.
...
| Code Block |
|---|
pipeforce.event.log.warn.{loggerName} |
pipeforce.event.webhook
This key forwards all webhook calls. The structure of the event message routing key is like this:
...
Whereas {name} is the name, the user has given to this webhook in the setup. The payload of the message contains the body of the webhook request.
pipeforce.event.workflow
Every workflow topic key can additionally contain dynamic values which will be replaced at runtime such as:
...
{wfName} = Will be replaced by the property name of the workflow definition in the workflow folder inside the app (example: myworkflow)
Workflow address variables ($uri:wf-)
In case a push event is a workflow event (pipeforce.event.workflow.#), these additional address variables can be used in TO, CC and BCC fields to refer to data from the event message:
...
Duplicate addresses will always be removed.
.comment.create
This event message is send after comment to a workflow process was created.
...
| Code Block |
|---|
pipeforce.event.workflow.comment.create.{appName}.{wfName}.{commentUuid} |
.comment.update
This event message is send after comment to a workflow process was updated.
...
| Code Block |
|---|
pipeforce.event.workflow.comment.update.{appName}.{wfName}.{commentUuid} |
.end
This event message is send after a workflow process have been finished.
...
| Code Block |
|---|
pipeforce.event.workflow.end.{appName}.{wfName} |
.task.assignment
This event message is send after the task assignee has changed.
...
| Code Block |
|---|
pipeforce.event.workflow.task.assignment.{appName}.{wfName} |
.task.complete
This event message is send after a task was completed.
...
| Code Block |
|---|
pipeforce.event.workflow.task.complete.{appName}.{wfName} |
.task.create
This event message is send after a new task in a workflow process was started (created).
...
| Code Block |
|---|
pipeforce.event.workflow.task.create.{appName}.{wfName} |
.task.delete
This event message is send after a task was deleted.
...
| Code Block |
|---|
pipeforce.event.workflow.task.delete.{appName}.{wfName} |
.task.timeout
This event message is send after a task timeout happened.
...
| Code Block |
|---|
pipeforce.event.workflow.task.delete.{appName}.{wfName} |
.task.update
This event message is send after a metadata or variables of a task have been updated.
...
| Code Block |
|---|
pipeforce.event.workflow.task.update.{appName}.{wfName} |
.transition
This event message is send after a (task) transition have been occurred from one state to another.
...
| Code Block |
|---|
pipeforce.event.workflow.transition.{appName}.{wfName} |
.start
This event message is send after a new workflow process have been started.
...