Events are used as part of defining event criteria in a trigger. When the event criteria specified in a trigger are met, an action is started. Certain connectors can be used for defining event criteria. For example, the email service event MESSAGE_RECEIVED can be used to monitor inbound emails. If a pattern defined in the trigger is met then a trigger action is started. See Triggers for further details on creating event criteria based on connectors.
Connector events contain a set of input and output parameters and the definition of the content of the event. Input parameters can be used to define a pattern for when an event should be created and output parameters can be used as values within a trigger action.
The properties for input and output parameters are:
| Property | Required | Description |
|---|---|---|
| Name | Required | The name of the parameter, for example: pattern |
| Description | Optional | A free text description of the parameter, for example: A regular expression to match against incoming messages |
| Type | Required | The data type of the parameter, for example: String |
| Required | Optional | Set whether the parameter requires a value when being used, for example: true |
An example of the JSON for the Twilio connector SMS_RECEIVED event is:
"events": {
"f5945447-92ee-4dd9-8277-9948a347264d": {
"id": "f5945447-92ee-4dd9-8277-9948a347264d",
"name": "SMS_RECEIVED",
"description": "Event that is dispatched when an SMS is received through Twilio",
"inputs": [
{
"id": "b42f4b40-46ab-4270-a163-0eddd8c91920",
"name": "condition",
"description": "Expression that shall be true in order to trigger an action. Event and payload can be used in variables.",
"type": "predicate",
"required": false
},
…
],
"outputs": [
{
"id": "46ad8f50-7c50-48ae-892d-256cfe688b89",
"name": "matchGroups",
"description": "Matching groups between pattern and message. They can be used in variables and the echo messages.",
"type": "json"
},
…
],
"model": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"type": "object",
"properties": {
"originalMessage": {
"type": "string"
},
"to": {
"type": "string"
},
"from": {
"type": "string"
}
},
"required": [
"originalMessage",
"to",
"from"
]
}
}
}
,
The model field describes the information that is included inside the data field of the Cloud Event handled in a trigger, for more see Trigger Events. This allows you to create a condition for a trigger using the condition builder and based on the event information. You can add or edit the model of the event in the editor by clicking the Add Model Schema or Edit Model Schema button.
In the editor on the left you can configure a JSON schema to describe an event. In the editor on the right you can enter a JSON object and validate it matches the schema on the left by clicking the Validate button. If it matches you will receive a validation success message.