Addons

Nuxeo Zapier Integration

Updated: September 24, 2019

The Nuxeo Zapier Integration addon is a plugin containing all the components to integrate Nuxeo Platform with the Zapier Platform.

Zapier provides workflows to automate the usage of web applications together. It is often described as a translator between Web APIs.

dashboard.png
dashboard.png

The Nuxeo Zapier integration allows end-user to:

  • Authenticate against Nuxeo instances with the add-on setup via OAuth 2
  • Configure Nuxeo Platform to subscribe to all Nuxeo Notifications (by default and custom)
  • Commands Nuxeo Platform via Nuxeo Automation operations

Prerequisites

Installation

From Command Line

Linux/Mac:

    NUXEO_HOME/bin/nuxeoctl mp-install nuxeo-zapier

Windows:

    NUXEO_HOME\bin\nuxeoctl.bat mp-install nuxeo-zapier

From the Marketplace

Install the Nuxeo Zapier Integration Package.

Configuration

Nuxeo Setup

  1. Start your server, log in as Administrator/Administrator

  2. Go to JSF UI using the url {server:port}/nuxeo/jsf and go to ADMIN > Cloud Services > Consumers

  3. Click on the Add button at the top right and fill in the popup window to configure nuxeo-zapier

    • Name: as you want
    • Client ID: nuxeo-zapier
    • Client Secret: Add your custom value (to be reused on Zapier's side)
    • Redirect URIs: Enter the URL provided by Zapier when configuring you Zap (see Zapier documentation).
      • Typically: https://zapier.com/dashboard/auth/oauth/return/App<YOUR_APP_ID>CLIAPI/
    • Check the Auto-grant box
    • Check the Activated box

Usage

You have two general ways to use Zapier with Nuxeo:

By creating triggers:

This will let Zapier subscribe to Nuxeo notifications (default or custom) for receiving Nuxeo events to forward to different other applications (Gmail, Trello, Youtube, Facebook, Dropbox, Slack, Salesforce, etc.)

By creating actions:

This will let you post data and/or execute processes on Nuxeo Platform after a trigger from another app (Gmail, Trello, Youtube, Facebook, Dropbox, Slack, Salesforce...) has been executed.

steps.png
steps.png

Authentication

When creating a Nuxeo trigger or action on Zapier, you will need to authenticate via OAuth 2.

On this screen, set the URL of your Nuxeo instance with the secret you set (as mentioned above in the Nuxeo Setup section). You will be invited to type your credentials for authenticating Zapier against Nuxeo.

auth.png
auth.png

Triggers

Two Nuxeo triggers are available on the Zapier platform:

  • A generic trigger that allows you to select the notification you would like to subscribe to.
  • A trigger that notifies Zapier each time a document is created for a given type(s).

triggers.png
triggers.png

genericnotif.png
genericnotif.png

specificnotif.png
specificnotif.png

Specific Actions

Five Nuxeo specific Actions are available on the Zapier platform:

  • Attach binary on a given document
  • Create a document in a given location
  • Update a given document
  • Import a document in a given location
  • Start a workflow on the given document(s)

actions.png
actions.png

wf.png
wf.png

Generic Automation Action

There is also one generic action to use any Nuxeo Automation operations:

  • You select any operations provided by the platform (default or custom)
  • Be careful to set inputs if required (Zapier won't validate this form)
  • Don't forget to set at least the required parameters

genericoperation.png
genericoperation.png

Regarding the metadata properties if suggested by the form, you can use the following format:

dc:title=######
dc:description=######
....

Jump lines to set another metadata (and don't forget you can use the dropdown to use the Zapier metadata results in this template).

operation.png
operation.png

We'd love to hear your thoughts!

All fields required