@planningcenter/core-automations 0.2.0 → 0.3.0-rc.1

package/README.md

@@ -28,9 +28,14 @@ import { Automations } from "@planningcenter/core-automations"
   currentPersonId={123456789}
   defaultApp="people"
   theme={theme} // Tapestry-React theme object
-  triggerConditions={{ data: { relationships: { form: { data: { id: form.id } } } } }}
-  triggerName="people.v2.events.form_submission.created"
-  triggerResource="vzfnx3tc87lx1c1d8Ak1clkrwqZfnA294t..."
+  trigger={{
+    conditions: { data: { relationships: { form: { data: { id: form.id } } } } },
+    events: [{
+      description: 'Submits this form',
+      name: 'people.v2.events.form_submission.created',
+    }],
+    resource: "vzfnx3tc87lx1c1d8Ak1clkrwqZfnA294t...",
+  }}
 />
 ```
 
@@ -46,9 +51,15 @@ import { Automations } from "@planningcenter/core-automations"
   }}
 - `defaultApp` (string): Which app should be selected by default?
 - `theme` (object) optional: Accepts a [Tapestry-React theme object](https://planningcenter.github.io/tapestry-react/theming)
-- `triggerConditions` (object): The specific conditions for triggering this automation
-- `triggerName` (string): Name of trigger
-- `triggerResource` (string): An encrypted trigger resource
+- `trigger` (object):
+  - `resource` (string): An encrypted trigger resource
+  - `conditions` (object): The specific conditions for triggering this automation
+  - `events` (array[object]): An array of objects describing the possible trigger events (created/deleted/etc)
+    - `name` (string): The event name (matches the webhooks message `routing_key`)
+    - `description` (string): Human-readable description of this event (the words after "When a person...", e.g. "Joins this group")
+- `afterCreateOptions` (object) optional: Options for performing an action after the automation is created:
+    - `label` (string): Description of the action to perform
+    - `onConfirm` (function): The function that will perform after the automation is created
 
 ### Theming