...
Events can be used to listen to certain things happened in PIPEFORCE or in other systems. It’s also possible to trigger such events from inside a pipeline.
| Table of Contents | ||||
|---|---|---|---|---|
|
The Event JSON
In PIPEFORCE an event is represented by a JSON object with a certain structure like this:
...
In this example we assume that the event contains the Salesforce Lead object so we can filter for the CountryCode here. But this depends on the implementation of the webhook.
Sending event
In order to send an event, you can use the event.send command. Here is an example:
| Code Block |
|---|
pipeline:
- event.send:
key: com.company.myevent |
Every time this pipeline gets executed, it will send a new event with key com.company.myevent. Optionally you also set the payload of the event using its payload parameter. This can be a literal or a pipeline expression (PE) which points to an object to be attached to the payload.
| Note |
|---|
Note: Whenever you send a custom event you need to prefix it with the reversed internet address of your company. In this example it is |
Built-in events
These are events which come out-of-the-box with PIPEFORCE. Here is a list of those officially supported events:
Event Key | Description | Payload |
|---|---|---|
| Fired every time a new property was created in the property store. | |