Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languageyaml
pipeline:
  - message.listen:
      key: pipeforce.event.workflow.#
      
  - mail.send:
      to: admin@company.tld
      subject: A workflow event happened.

Pattern matching

When registering a listener for an event key, also pattern matching can be used:

...

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

Default headers

Every message contains these default headers:

  • "namespace": ns
    Whereas ns is the namespace this event happened inside. Cannot be changed for security reasons.

  • "content_type": application/json
    This is fixed. Every An event message body is always of type JSON.

Reference Documentation

Here is the reference of these event messages and their keys (also known as topics):

...

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:

  • $uri:wf-authenticated-user = Returns the $uri:user:<username> of the user who was logged-in at the time of this event and potentially has initiated this event.

  • $uri:wf-process-involved-users = Returns the $uri:user:<username> of all users involved in the workflow process.

  • $uri:wf-started-by = Returns the $uri:user:<username> of the user who started the workflow.

  • $uri:wf-task-candidate-groups = Returns the $uri:group:<name> names of all groups which are set as candidate group of given task. In case there is no candidate group set, the address variable will be removed from all address fields.

  • $uri:wf-task-assignee = Returns the $uri:user:<username> of the user who is set as assignee on given workflow task. In case there is no taskAssignee set, the address variable will be removed from all address fields.

  • $uri:wf-task-owner = Returns the $uri:user:<username> of the user who is set as assignee on the given workflow task. In case there is no taskOwner set, the address variable will be removed from all address fields.

  • $uri:author = In case the event is related to a comment creation, returns the $uri:user:<username> of the user who created the comment. This is also true for comments created outside of workflow related events.

Duplicate addresses will always be removed.. See here for more details: https://logabit.atlassian.net/wiki/spaces/PA/pages/2767224839/Notifications#%24uri%3Awf--(workflow-addresses)

.comment.create

This event message is send after comment to a workflow process was created.

...