Skip to content

Commit 4feb2bc

Browse files
authored
Update readme.md
1 parent 667675b commit 4feb2bc

File tree

1 file changed

+21
-8
lines changed
  • src/Umbraco.Forms.Integrations.Automation.Zapier

1 file changed

+21
-8
lines changed

src/Umbraco.Forms.Integrations.Automation.Zapier/readme.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Umbraco.Forms.Integrations.Automation.Zapier
22

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.
44

55
A Zap is an automated workflow that connects various apps and services together. Each Zap consists of a trigger and one or more actions.
66

@@ -23,25 +23,38 @@ The Umbraco app manages two types of events:
2323

2424
The trigger event to be used by this integration is _New Form Submission_.
2525

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.
28+
```
29+
<appSettings>
30+
...
31+
<add key="Umbraco.Forms.Integrations.Automation.Zapier.ApiKey" value="[your_api_key]" />
32+
...
33+
</appSettings>
34+
```
2735

28-
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.
2937

3038
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
3139
setting in `Web.config`:
3240

3341
```
3442
<appSettings>
3543
...
36-
<add key="Umbraco.Cms.Integrations.Automation.Zapier.UserGroup" value="[your User Group]" />
44+
<add key="Umbraco.Forms.Integrations.Automation.Zapier.UserGroup" value="[your_user_group]" />
3745
...
3846
</appSettings>
3947
```
4048

4149
### Working With the Zapier Forms Integration
42-
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.
4355

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
4659

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

Comments
 (0)