@planningcenter/core-automations 1.5.0-alpha.2 → 1.5.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/cjs/core-automations.esm.js +1 -1
- package/dist/cjs/core-automations.esm.js.map +1 -1
- package/dist/cjs/core-automations.js +1 -1
- package/dist/cjs/core-automations.js.map +1 -1
- package/dist/cjs/core-automations.modern.mjs +1 -1
- package/dist/cjs/core-automations.modern.mjs.map +1 -1
- package/dist/cjs/core-automations.umd.js +1 -1
- package/dist/cjs/core-automations.umd.js.map +1 -1
- package/dist/types/src/field.d.ts.map +1 -1
- package/dist/types/src/new_automation.d.ts.map +1 -1
- package/dist/types/src/new_automation.stories.d.ts +9 -1
- package/dist/types/src/new_automation.stories.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -140,9 +140,12 @@ import { Automations } from "@planningcenter/core-automations"
|
|
|
140
140
|
- `theme` (object) optional: Accepts a [Tapestry-React theme object](https://planningcenter.github.io/tapestry-react/theming)
|
|
141
141
|
- `trigger` (object):
|
|
142
142
|
- `conditions` (object): The specific conditions for triggering this automation: Should be a subset of the message payload
|
|
143
|
+
- `dynamicConditions` (DefinitionField[]): An array of extra fields that can be used to customize the trigger conditions
|
|
143
144
|
- `events` (object[]): An array of objects describing the possible trigger events (created/deleted/etc)
|
|
144
145
|
- `name` (string): The event name (matches the webhooks message `routing_key`)
|
|
145
146
|
- `description` (string): Human-readable description of this event (the words after "When a person...", e.g. "Joins this group")
|
|
147
|
+
- `conditions` (object) optional: The specific conditions for triggering this automation: Should be a subset of the message payload
|
|
148
|
+
- `dynamicConditions` (DefinitionField[]) optional: An array of extra fields that can be used to customize the trigger conditions
|
|
146
149
|
- `triggerParams` (object[]) optional: An array of objects describing additional parameters which the trigger can use for determining whether to run etc.
|
|
147
150
|
- `key` (string): The parameter key
|
|
148
151
|
- `defaultValue` (any): What the parameter value defaults to
|