Skip to content

Commit fc32de1

Browse files
authored
Updated readme
1 parent b0fac31 commit fc32de1

File tree

1 file changed

+16
-8
lines changed
  • src/Umbraco.Cms.Integrations.Automation.Zapier

1 file changed

+16
-8
lines changed

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

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

3-
This integration provides a dashboard interface that allows users to map content types with Zap triggers webhooks.
3+
This integration provides a dashboard interface that allows users to vizualize registered subscription hooks. When a Zap is turned on, the subscription hook is saved into the database; turning off the Zap will remove the registered subscription hook.
44

5-
When the content type gets published, the details of the configuration are looked up into the database and if a record is found,
6-
will send a request to the Zap, triggering the matching actions.
5+
When content gets published, the content type is looked up in the subscription hooks list from the database, and if a record is found, A POST request will be sent to the webhook URL with details of the current node. This eventually will cause the Zap's trigger to be invoked, triggering the assigned actions of the Zap.
76

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

@@ -26,9 +25,17 @@ The Umbraco app manages two types of events:
2625

2726
The trigger event to be used by this integration is _New Content Published_.
2827

29-
When creating the Zap trigger, you will be prompted to enter a username, password and the URL for your Umbraco website.
28+
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.
29+
If the following setting is present, then the API key based authentication will take precendence and will be the main method of authorization.
30+
```
31+
<appSettings>
32+
...
33+
<add key="Umbraco.Cms.Integrations.Automation.Zapier.ApiKey" value="[your_api_key]" />
34+
...
35+
</appSettings>
36+
```
3037

31-
Then the Umbraco application will validate the credentials entered and return a message in case the validation fails.
38+
If no API key is present, then the Umbraco application will validate the credentials entered and return a message in case the validation fails.
3239

3340
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
3441
setting in `Web.config`:
@@ -46,9 +53,10 @@ In the _Content_ area of the backoffice, find the _Zapier Integrations_ dashboar
4653

4754
The dashboard is composed of two sections:
4855
* Content Properties - Zapier details and input fields for adding content configurations
49-
* Registered Webhooks - list of created content configurations
56+
* Registered Subscription Hooks - list of registered entities.
5057

51-
Each content type can only have one webhook configuration attached. After a configuration has been added for a specific content type, the content type item gets removed from the input field,
52-
and it can be restored by deleting the configuration from the database.
58+
Subscription hooks are split in two categories:
59+
* 1 = Content
60+
* 2 = Form
5361

5462
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)