Obscreen Docs

Appearance

n8n Integration ​

Obscreen offers native integration with n8n, an open-source workflow automation platform. This integration allows you to automate your digital signage content management directly from your n8n workflows.

About the n8n-nodes-obscreen Node ​

The community node n8n-nodes-obscreen is available on GitHub: obscreen/n8n-nodes-obscreen

This node allows you to use the Obscreen API in your n8n workflows to fully automate your digital signage.

Prerequisites ​

To use this integration, you need:

  1. An Obscreen Instance with the Core API plugin enabled (Premium feature)
  2. Your Obscreen Instance URL
  3. Your Obscreen API Key (available in any user's security settings)

Optional Security Note: You can configure your instance to permit unauthenticated access to the API. If you do so, you can set a random value as the API Key.

Installation ​

Follow the installation guide in the n8n community nodes documentation.

bash
npm install n8n-nodes-obscreen

Available Operations ​

Content ​

  • List all contents: Retrieve the complete list of your contents
  • Add new content: Create new content elements
  • Update existing content: Modify content properties
  • Delete content: Remove content from your library
  • Get content: Retrieve details of a specific content
  • Get content location: Locate content in your structure
  • Get available content types: List all supported formats

Content Folder ​

  • List all content folders: Browse your folder structure
  • Add new content folder: Create new organization
  • Update a folder: Modify folder properties
  • Delete a folder: Remove a folder from your structure
  • Move multiple contents to a folder: Organize your contents in bulk

Playlist ​

  • List all playlists: Retrieve your playlists
  • Add a playlist: Create new content sequences
  • Update existing playlist: Modify order or content
  • Delete playlist: Remove a playlist
  • Get playlist: Retrieve details of a specific playlist
  • Get regular slides associated with playlist: List main content
  • Get notifications slides associated with playlist: List notifications

Slide ​

  • List all slides: Browse your slides
  • Add a regular slide: Create standard content
  • Add a notification slide: Create alerts or announcements
  • Update existing slide: Modify slide content
  • Delete slide: Remove a slide
  • Get slide: Retrieve details of a specific slide

Process ​

  • Refresh player: Force content update on your screens

Typical Use Cases ​

Content Automation ​

  • Automatic updates: Synchronize your content with external sources (CMS, databases, APIs)
  • Event management: Automatically create slides for scheduled events
  • Dynamic notifications: Broadcast alerts based on external triggers

Integration with Other Systems ​

  • CRM/ERP: Display real-time business data
  • Social networks: Integrate Twitter, Instagram, or LinkedIn feeds
  • Weather and news: Automatically update contextual information
  • Booking systems: Display real-time availability

Fleet Management ​

  • Mass deployment: Push content to multiple screens simultaneously
  • Preventive maintenance: Automate checks and updates
  • Automated reports: Generate usage statistics

Compatibility ​

This node is compatible with n8n version 0.150.0 and above. It has been tested with the latest version of n8n.

Development and Contribution ​

The project is open-source under MIT license. To contribute or develop:

bash
npm install
npm link
npm run dev

In a separate terminal, start the n8n server:

bash
cd .n8n
mkdir custom    
cd custom 
npm init
npm link @n8n-nodes-obscreen
npm start

Support and Resources ​