diff --git a/README.md b/README.md index b6eedb5..9647665 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,19 @@ Screenly Zapier Integration A Zapier [integration](https://zapier.com/apps/screenly/integrations) for automating Screenly digital signage operations. Connect your Screenly displays with 5000+ apps. -## :rocket: Quick Start +## :rocket: Getting Started -You can start by creating a new workflow that will create a new Screenly asset when a new file is uploaded to a specific folder in your Google Drive. Please see this [guide](/docs/cookbook/uploading-an-asset-via-google-drive.md) for details. +Check out our tutorials for getting started with the Screenly Zapier integration: + +- [Manage digital signage content with Box & Zapier](https://www.screenly.io/tutorials/box/) +- [Use Dropbox & Zapier to manage digital signage content](https://www.screenly.io/tutorials/dropbox/) +- [Use Google Drive to manage Screenly via Zapier](https://www.screenly.io/tutorials/google-drive/) ## :zap: Quick Links - [Available Actions](docs/available-actions.md) - [Developer Documentation](docs/developer-documentation.md) - [Common Use Cases](docs/common-use-cases.md) -- [Example Integrations](docs/example-integrations.md) -- [Cookbook](docs/cookbook/README.md) ## :lock: Security diff --git a/docs/cookbook/README.md b/docs/cookbook/README.md deleted file mode 100644 index 27511eb..0000000 --- a/docs/cookbook/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# :cook: Cookbook - -This documentation is a collection of how-to guides for using the Screenly integration with third-party applications like Google Drive, Dropbox, and more. - -## Quick Links - -- [Uploading an Asset via Google Drive](uploading-an-asset-via-google-drive.md) -- [Uploading an Asset via Dropbox](uploading-an-asset-via-dropbox.md) diff --git a/docs/cookbook/images/zapier-dropbox-01-trigger-setup.png b/docs/cookbook/images/zapier-dropbox-01-trigger-setup.png deleted file mode 100644 index b1a35c4..0000000 Binary files a/docs/cookbook/images/zapier-dropbox-01-trigger-setup.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-dropbox-02-trigger-configure.png b/docs/cookbook/images/zapier-dropbox-02-trigger-configure.png deleted file mode 100644 index e11ebe0..0000000 Binary files a/docs/cookbook/images/zapier-dropbox-02-trigger-configure.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-dropbox-03-action-setup.png b/docs/cookbook/images/zapier-dropbox-03-action-setup.png deleted file mode 100644 index 61d3988..0000000 Binary files a/docs/cookbook/images/zapier-dropbox-03-action-setup.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-dropbox-04-action-configure.png b/docs/cookbook/images/zapier-dropbox-04-action-configure.png deleted file mode 100644 index 94a7a72..0000000 Binary files a/docs/cookbook/images/zapier-dropbox-04-action-configure.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-dropbox-05-zap-runs.png b/docs/cookbook/images/zapier-dropbox-05-zap-runs.png deleted file mode 100644 index 1652fa4..0000000 Binary files a/docs/cookbook/images/zapier-dropbox-05-zap-runs.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-google-drive-01-trigger-setup.png b/docs/cookbook/images/zapier-google-drive-01-trigger-setup.png deleted file mode 100644 index e253386..0000000 Binary files a/docs/cookbook/images/zapier-google-drive-01-trigger-setup.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-google-drive-02-trigger-configure.png b/docs/cookbook/images/zapier-google-drive-02-trigger-configure.png deleted file mode 100644 index ac0f9eb..0000000 Binary files a/docs/cookbook/images/zapier-google-drive-02-trigger-configure.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-google-drive-03-action-setup.png b/docs/cookbook/images/zapier-google-drive-03-action-setup.png deleted file mode 100644 index 638237a..0000000 Binary files a/docs/cookbook/images/zapier-google-drive-03-action-setup.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-google-drive-04-action-configure.png b/docs/cookbook/images/zapier-google-drive-04-action-configure.png deleted file mode 100644 index 2fce46a..0000000 Binary files a/docs/cookbook/images/zapier-google-drive-04-action-configure.png and /dev/null differ diff --git a/docs/cookbook/images/zapier-google-drive-05-zap-runs.png b/docs/cookbook/images/zapier-google-drive-05-zap-runs.png deleted file mode 100644 index 76752d1..0000000 Binary files a/docs/cookbook/images/zapier-google-drive-05-zap-runs.png and /dev/null differ diff --git a/docs/cookbook/uploading-an-asset-via-dropbox.md b/docs/cookbook/uploading-an-asset-via-dropbox.md deleted file mode 100644 index d49396d..0000000 --- a/docs/cookbook/uploading-an-asset-via-dropbox.md +++ /dev/null @@ -1,70 +0,0 @@ -# Uploading an Asset via Dropbox - -## Step 1 — First Steps - -Go to the [Zapier Zaps page](https://zapier.com/app/assets/zaps) and click **Create**. -Click **New Zap** from the dropdown menu. You will be redirected to the Zap editor. - -## Step 2 — Select The Trigger Event - -Click the **Trigger** button. In the modal that appears, search for and select **Dropbox**. - -During setup, you'll need to configure: - -- **Trigger Event**: Select **New File in Folder** -- **Account**: Click **Sign In** and authenticate with your Dropbox account. When prompted, allow Zapier to access your Dropbox files. -- Click **Continue** - -![Dropbox trigger setup](/docs/cookbook/images/zapier-dropbox-01-trigger-setup.png) - -For configuration: - -- Select the **Space** and **Folder** you want to monitor. -- Select **False** for **Include files in subfolders?** -- Keep **Include file contents?** set to **Yes** -- Keep **Include sharing link?** set to **Yes** -- Click **Continue** -- Click **Test Trigger** (or **Skip Test** to proceed without testing) - -![Dropbox trigger configuration](/docs/cookbook/images/zapier-dropbox-02-trigger-configure.png) - -## Step 3 — Select The Action Event - -- Click the **Action** button -- Search for and select **Screenly (x.y.z)** -- For **Action Event**, select **Upload Asset** - -For **Account**: - -- Click **Sign In** -- In the new window, enter your Screenly API key -- Click **Yes, Continue to Screenly (x.y.z)** -- Click **Continue** - -![Screenly action setup](/docs/cookbook/images/zapier-dropbox-03-action-setup.png) - -Configure the action: - -- For **File URL**: Click **+** and select **Link** -- For **Title**: Click **+** and select **File Name** -- Click **Continue** -- Click **Test Step** (or **Skip Test** to proceed without testing) - -![Screenly action configuration](/docs/cookbook/images/zapier-dropbox-04-action-configure.png) - -## Step 4 — Save and Publish - -Click **Publish**. Once redirected to the confirmation page, ensure the Zap is enabled -using the toggle switch. - -## Step 5 — Test Your Zap - -- Upload a file to your selected Dropbox folder -- Wait a few minutes for processing -- Visit [screenly.io](https://www.screenly.io/) and sign in -- Click **Content** in the menu bar -- Verify that your new asset appears - -You can monitor the Zap's execution in the [Zap history](https://zapier.com/app/history). - -![Screenly action configuration](/docs/cookbook/images/zapier-dropbox-05-zap-runs.png) diff --git a/docs/cookbook/uploading-an-asset-via-google-drive.md b/docs/cookbook/uploading-an-asset-via-google-drive.md deleted file mode 100644 index a2ca852..0000000 --- a/docs/cookbook/uploading-an-asset-via-google-drive.md +++ /dev/null @@ -1,68 +0,0 @@ -# Uploading an Asset via Google Drive - -## Step 1 — First Steps - -Go to the [Zapier Zaps page](https://zapier.com/app/assets/zaps) and click **Create**. -Click **New Zap** from the dropdown menu. You will be redirected to the Zap editor. - -## Step 2 — Select The Trigger Event - -Click the **Trigger** button. In the modal that appears, search for and select **Google Drive**. - -During setup, you'll need to configure: - -- **Trigger Event**: Select **New File in Folder** -- **Account**: Click **Sign In** and authenticate with your preferred Google account. - When prompted, allow Zapier to access your Google Drive. -- Click **Continue** - -![Google Drive trigger setup](/docs/cookbook/images/zapier-google-drive-01-trigger-setup.png) - -For configuration: - -- Select the **Drive** and **Folder** you want to monitor -- Click **Continue** -- Click **Test Trigger** (or **Skip Test** to proceed without testing) - -![Google Drive trigger configuration](/docs/cookbook/images/zapier-google-drive-02-trigger-configure.png) - -## Step 3 — Select The Action Event - -- Click the **Action** button -- Search for and select **Screenly (x.y.z)** -- For **Action Event**, select **Upload Asset** - -For **Account**: - -- Click **Sign In** -- In the new window, enter your Screenly API key -- Click **Yes, Continue to Screenly (x.y.z)** -- Click **Continue** - -![Screenly action setup](/docs/cookbook/images/zapier-google-drive-03-action-setup.png) - -Configure the action: - -- For **File URL**: Click **+** and select **File** -- For **Title**: Click **+** and select **Title** -- Click **Continue** -- Click **Test Step** (or **Skip Test** to proceed without testing) - -![Screenly action configuration](/docs/cookbook/images/zapier-google-drive-04-action-configure.png) - -## Step 4 — Save and Publish - -Click **Publish**. Once redirected to the confirmation page, ensure the Zap is enabled -using the toggle switch. - -## Step 5 — Test Your Zap - -- Upload a file to your selected Google Drive folder -- Wait a few minutes for processing -- Visit [screenly.io](https://www.screenly.io/) and sign in -- Click **Content** in the menu bar -- Verify that your new asset appears - -You can monitor the Zap's execution in the [Zap history](https://zapier.com/app/history). - -![Screenly content](/docs/cookbook/images/zapier-google-drive-05-zap-runs.png) diff --git a/docs/example-integrations.md b/docs/example-integrations.md deleted file mode 100644 index cf8c245..0000000 --- a/docs/example-integrations.md +++ /dev/null @@ -1,67 +0,0 @@ -# Example Integrations - -## Cloud Storage Integrations - -### Dropbox - -1. **Simple Asset Upload** - - - Trigger: New file in Dropbox folder - - Action: Upload to Screenly - - Use Case: Quickly add new content to your Screenly library - -2. **Automated Playlist Management** - - Trigger: New file in specific Dropbox folder - - Action: Complete Workflow (Upload + Playlist + Screen) - - Use Case: Different folders map to different screens/playlists - -### Box - -1. **Content Library Management** - - - Trigger: New file in Box folder - - Action: Upload to Screenly with metadata - - Use Case: Use Box metadata for asset scheduling - -2. **Multi-Screen Campaign** - - Trigger: New file with specific tag in Box - - Action: Complete Workflow - - Use Case: Marketing campaigns across multiple screens - -### SharePoint - -1. **Corporate Communications** - - - Trigger: New file in SharePoint document library - - Action: Complete Workflow - - Use Case: Display company announcements on office screens - -2. **Department-Specific Content** - - - Trigger: New file in department SharePoint folder - - Action: Upload + Add to Department Playlist - - Use Case: Each department manages their own digital signage content - -3. **Event Display Management** - - - Trigger: New item in SharePoint Events list - - Action: Complete Workflow with scheduling - - Use Case: Automatically display event information during relevant times - -4. **Multi-Location Content Distribution** - - Trigger: New file in SharePoint with location metadata - - Action: Complete Workflow with screen selection - - Use Case: Distribute content to specific office locations based on SharePoint metadata - -## Automated Maintenance - -1. **Content Cleanup** - - - Trigger: Schedule (e.g., weekly) - - Action: Cleanup Zapier Content - - Use Case: Maintain a clean asset library by removing old content - -2. **Content Rotation** - - Trigger: Schedule or SharePoint/Dropbox/Box update - - Action: Complete Workflow with end dates - - Use Case: Automatically rotate content based on schedules