Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 12 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,23 @@
# Screenly Zapier Integration
<h1 align="center">
Screenly Zapier Integration
</h1>

<p align="center">
<img src="assets/logo-full.svg" alt="Screenly for Zapier" width="400">
<img src="assets/logo-full.svg" alt="Screenly for Zapier" width="90%">
</p>

[![Test](https://github.com/screenly/zapier/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/screenly/zapier/actions/workflows/test.yml)
<p align="center">
<a href="https://github.com/screenly/zapier/actions/workflows/test.yml?query=branch%3Amaster">
<img src="https://img.shields.io/github/actions/workflow/status/screenly/zapier/test.yml?branch=master&style=for-the-badge&label=Test&logo=github" alt="Test Status">
</a>
</p>

A Zapier integration for automating Screenly digital signage operations. Connect your
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

### Step 1 &mdash; Install the Integration

> [!NOTE]
> There is no public version of this integration yet. In the meantime, you can
> install it privately by following the steps below.

- Run the following command to set up and install the integration privately:

```bash
zapier login
zapier register "Screenly"
```

- Push the changes to Zapier:

```bash
zapier push
```

### Step 2 &mdash; Create Your First Zap

- Go to [Zapier](https://zapier.com).
- Go to the sidebar and click "Create".
- Choose your trigger app (e.g., Dropbox, SharePoint, Google Drive).
We will use Dropbox as an example.
- Select a "Trigger event" from the list of available events. For example,
select "New File in Folder". Configure what directory you want to monitor.
- Choose Screenly as your action app.
- Select the action event that you want to be executed. For example,
select "Upload Asset". Click "Continue".
- Configure the "Action Event". For example, select the folder you want to monitor.
- For the "Account", link your Screenly account.
It should open a new window that asks for your Screenly API token. Once
you confirm, it should be linked to your Zap.
- Click "Continue".
- For "File URL", select "Direct Media Link".
- For "Title", select "File Name".
- Click "Continue". Feel free to "Skip test".
- Click "Publish".
- Make sure that the Zap is enabled.
- Upload your file to the folder you configured.
- Go to your Screenly dashboard and click "Content" from the sidebar.
- You should see the new asset that was uploaded.
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.

## :zap: Quick Links

Expand All @@ -67,4 +31,4 @@ Screenly displays with 5000+ apps.

- API keys are stored securely by Zapier
- All API requests are made over HTTPS
- The integration follows Zapier's security best practices
- The integration follows Zapier's security best practices
30 changes: 18 additions & 12 deletions docs/developer-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,20 @@ These tests are skipped locally to avoid environment-specific issues.
- Visual tests run on pull requests
- CI checks must pass before merge

## Setting up Zapier Deployment

1. Get your Zapier Deploy Key:

```bash
zapier login
zapier register "Screenly" # Only needed for first-time setup
```

2. Add the deploy key to GitHub:
- Go to your repository's Settings > Secrets > Actions
- Add a new secret named `ZAPIER_DEPLOY_KEY`
- Paste your deploy key as the value

## Deployment

The integration is automatically deployed to Zapier when a new version tag is pushed to GitHub.
Expand All @@ -141,19 +155,11 @@ The integration is automatically deployed to Zapier when a new version tag is pu
- Run tests
- Deploy to Zapier

## Setting up Zapier Deployment

1. Get your Zapier Deploy Key:

```bash
zapier login
zapier register "Screenly" # Only needed for first-time setup
```
If you wish to deploy the integration privately, you can do so by following the steps below, given that you have completed the [initial setup steps above](#setting-up-zapier-deployment).

2. Add the deploy key to GitHub:
- Go to your repository's Settings > Secrets > Actions
- Add a new secret named `ZAPIER_DEPLOY_KEY`
- Paste your deploy key as the value
```bash
zapier push
```

## Version Management

Expand Down
Loading