Trigger Provider¶
The Trigger Provider is usually a read-only object provided by the server or the trigger plugin.
These define methods to receive a trigger. Some are event handlers, webhook processors, or time-based processors.
See kaholo-tools for the webhook and other service integration trigger providers.
| Field | Definition |
|---|---|
| Description | Description is a string for providing a simple description |
| Documentation | Documentation is a string for providing additional in depth information. |
| Meta | Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata |
| Method | Method defines the method used on that URL |
| Name | Name is the key of this particular TriggerProvider. required: true |
| NoURL | NoURL indicates that a URL should NOT be created |
| OptionalParameters | OptionalParameters define the optional values that can be in Params on the Trigger |
| Params | Params holds the values of parameters on the object. The field is a key / value store of the parameters. The key is the name of a parameter. The key is of type string. The value is the value of the parameter. The type of the value is defined by the parameter object. If the key doesn't reference a parameter, the type of the object can be anything. The system will enforce the named parameter's value's type. Go calls the "anything" parameters as "interface {}". Hence, the type of this field is a map[string]interface{}. |
| Profiles | Profiles is an array of profiles to apply to this object in order when looking for a parameter during rendering. |
| RequiredParameters | RequiredParameters define the values that must be in Params on the Trigger |