Zapier

Details an integration available for Zapier, built and maintained by Umbraco HQ.

This integration provides a dashboard interface that allows users to visualize 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.

When content gets published, the content type is looked up in the subscription hooks list from the database. If a record is found, a POST request will be sent to the webhook URL with details of the current node. This will cause the Zap's trigger to be invoked, triggering the assigned actions of the Zap.

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

Package Links

• NuGet install

• Source code

• Umbraco marketplace listing

Minimum version requirements

To ensure compatibility, check the Dependencies tab on NuGet for the required Umbraco CMS version. For example, see Umbraco.Cms.Integrations.Automation.Zapier.

Version 2.0.0 and up

Version 2.0.0 of the integration adds some breaking changes to the Zaps creation flow with the new API endpoints and the Web Components-based Umbraco backoffice.

As a result, users on Umbraco 14+ will need to use version 3.0.0 of the Umbraco Zapier application.

Version 3.0.0 of the Umbraco app is available in the Zapier marketplace via the following invitation: https://zapier.com/developer/public-invite/157905/5f6dc86efe92c244cf0b2ff62af9d747/

Zapier allows only one version of the application to be public. Because the current version is used by instances running Umbraco <= 13, the latest version can be installed through the invite URL above.

Authentication

For this integration, the authentication is managed on Zapier's side by using the Umbraco Marketplace app.

The trigger event to be used by this integration is New Content Published.

When creating the Zap trigger, you will be prompted to enter a username, password, and URL for your Umbraco website. Alternatively, you can use an API key.

If the following setting is present, the API key-based authentication will take precedence and will be the main method of authorization.

Versions 9 and above

appsettings.json

"Umbraco": {
  "CMS": {
    "Integrations": {
      "Automation": {
        "Zapier": {
          "Settings": {
            "ApiKey": "[your_api_key]"
          }
        }
      }
    }
  }
}

Version 8

web.config

<appSettings>
  <add key="Umbraco.Cms.Integrations.Automation.Zapier.ApiKey" value="[your_api_key]" />
</appSettings>

If no API key is present, the Umbraco application will validate the credentials entered and return a message in case the validation fails.

To enhance security, you can specify a User Group that the user connecting needs to be a part of. You can achieve this by adding the following setting in the configuration file.

Versions 9 and above

appsettings.json

"Umbraco": {
  "CMS": {
    "Integrations": {
      "Automation": {
        "Zapier": {
          "Settings": {
            ...
            "UserGroup": "[your User Group]"
          }
        }
      }
    }
  }
}

Version 8

web.config

<appSettings>
  <add key="Umbraco.Cms.Integrations.Automation.Zapier.UserGroup" value="[your User Group]" />
</appSettings>

Working With the Zapier Cms Integration

In the Content area of the backoffice, find the Zapier Integrations dashboard.

The dashboard is composed of two sections:

• Content Properties - Zapier details and input fields for adding content configurations

• Registered Subscription Hooks - a list of registered entities.

The Trigger Webhook action will send a test request to the Zap trigger, enabling the preview of requests in the Zap setup workflow.