You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/Umbraco.Forms.Integrations.Automation.Zapier/readme.md
+21-8Lines changed: 21 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Umbraco.Forms.Integrations.Automation.Zapier
2
2
3
-
This integration provides a custom workflow allowing form entries to be mapped to the fields of a Zap tool trigger from Zapier.
3
+
This integration is an add-on to the Umbraco CMS integration available [here](https://github.com/umbraco/Umbraco.Cms.Integrations/tree/main/src/Umbraco.Cms.Integrations.Automation.Zapier), and provides necessary components for handling form submissions based on the registered subscription hooks.
4
4
5
5
A Zap is an automated workflow that connects various apps and services together. Each Zap consists of a trigger and one or more actions.
6
6
@@ -23,25 +23,38 @@ The Umbraco app manages two types of events:
23
23
24
24
The trigger event to be used by this integration is _New Form Submission_.
25
25
26
-
When creating the Zap trigger, you will be prompted to enter a username, password and the URL for your Umbraco website.
26
+
When creating the Zap trigger, you will be prompted to enter a username, password and the URL for your Umbraco website, or you can use instead an API key.
27
+
If the following setting is present, then the API key based authentication will take precendence and will be the main method of authorization.
Then the Umbraco application will validate the credentials entered and return a message in case the validation fails.
36
+
If no API key is present, then the Umbraco application will validate the credentials entered and return a message in case the validation fails.
29
37
30
38
If you want to extend the security layer, you can also specify a user group that the user trying to connect needs to be a part of, by adding the following
31
39
setting in `Web.config`:
32
40
33
41
```
34
42
<appSettings>
35
43
...
36
-
<add key="Umbraco.Cms.Integrations.Automation.Zapier.UserGroup" value="[your User Group]" />
Add the _Trigger Zap_ workflow to a form, configure which fields will be sent to the Zap and add the webhook URL of the Zap.
50
+
In the _Content_ area of the backoffice, find the _Zapier Integrations_ dashboard.
51
+
52
+
The dashboard is composed of two sections:
53
+
* Content Properties - Zapier details and input fields for adding content configurations
54
+
* Registered Subscription Hooks - list of registered entities.
43
55
44
-
You can add mappings for each of the form's fields (if no mapping is created, all fields will be included by default), and also pick one of the
45
-
standard fields: Form ID, Form Name, Page URL, Submission date/time.
56
+
Subscription hooks are split in two categories:
57
+
* 1 = Content
58
+
* 2 = Form
46
59
47
-
When the form is submitted, the workflow will be invoked and a POST request, with the content built based on the workflow's settings, will trigger the Zap and the actions will be executed.
60
+
The _Trigger Webhook_ action will send a test request to the Zap trigger, enabling the preview of requests in the Zap setup workflow.
0 commit comments