Page Comparison

A topic in a push subscription is a routing key pattern of an event message which always starts with prefix pipeforce.event, followed by the concrete topic type.

In case the routing key of a an event message matches this pattern, a new push notification will be generated and send to all addresses as configured in the push subscription.

The topic can contain wildcards:

• * = Stands for a single word up to the next period .

• # = Stands for multiple words with multiple periods in between.

For example: pipeforce.event.workflow.# matches all workflow event messages while pipeforce.event.workflow.*.my.app matches only workflow event messages inside the app my.app.

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.

The full structure of the event message routing key is like this:

pipeforce.event.app.install.finished

.uninstall.finished

This event message is send after an app was successfully uninstalled.

The full structure of the event message routing key is like this:

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.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.client.create.client

.admin.update.client

This event message is send after a client was updated by an admin.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.update.client

.admin.delete.client.scope.client.mapping

This event message is send after a client scope mapping was deleted.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.delete.client.scope.client.mapping

.admin.create.group

This event message is send after a new group was created.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.create.group

.admin.create.user

This event message is send after a new user was created.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.create.user

.admin.client.create.role

This event message is send after a new role was created.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.create.role

.admin.create.group.membership

This event message is send after a member was added to a group.

The full structure of the event message routing key is like this:

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.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.create.realm.role.mapping

.admin.action.user

This event message is send after a user has done a predefined action.

The full structure of the event message routing key is like this:

pipeforce.event.iam.admin.action.user

.client.login

This event message is send after an OAuth2 client has been logged-in.

The full structure of the event message routing key is like this:

pipeforce.event.iam.client.login

.code.to.token

This event message is send after a code has been exchanged to token.

The full structure of the event message routing key is like this:

pipeforce.event.iam.code.to.token

.login

This event message is send after user has successfully logged-in.

The full structure of the event message routing key is like this:

pipeforce.event.iam.login

.logout

This event message is send after user has successfully logged-out.

The full structure of the event message routing key is like this:

pipeforce.event.iam.login

.refresh.token

This event message is send after a token has been refreshed.

The full structure of the event message routing key is like this:

pipeforce.event.iam.refresh.token

.token.exchange

This event message is send after a token has been exchanged.

The full structure of the event message routing key is like this:

pipeforce.event.iam.token.exchange

.user.info.request

This event message is send after user information have been requested.

The full structure of the event message routing key is like this:

pipeforce.event.iam.user.info.request

pipeforce.event.

...

property

This topic group forwards all property events as push notifications.

Every property topic key can additionally contain dynamic variables which will be replaced at runtime such as:

{appName} = Will be replaced by the app name the property is stored inside (example: io.pipeforce.myapp).

{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.

The full structure of the event message routing key is like this:

pipeforce.event.property.created.{path}

.deleted

This event message is send after a property was deleted.

The full structure of the event message routing key is like this:

pipeforce.event.property.deleted.{path}

.updated

This event message is send after a property was updated.

The full structure of the event message routing key is like this:

pipeforce.event.property.updated.{path}

.comment.created

This event message is send after a comment was added to a property.

The full structure of the event message routing key is like this:

pipeforce.event.property.comment.created.{appName}

.comment.updated

This event message is send after a comment was updated to a property.

The full structure of the event message routing key is like this:

pipeforce.event.property.comment.updated.{appName}

pipeforce.event.log

This topic group forwards all important log events of severity level WARN or higher.

Every log topic key can additionally contain dynamic variables which will be replaced at runtime such as:

{loggerName} = The name of the logger used internally.

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.

The full structure of the event message routing key is like this:

pipeforce.event.log.error.{loggerName}

.warn

This event message is send after a new log entry of level WARN was created.

The full structure of the event message routing key is like this:

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:

pipeforce.event.webhook.{name}

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:

...