Jump to Content

Introduction

What Relay Is: An Overview
Workflow Automation
Relay Capabilities
Example Use Cases
Next Steps
FAQs

SDK Quick Start

SDK Overview
Before You Start
Run a built-in workflow
Writing a custom workflow

SDK Concepts

Inputs, Processing, and Outputs
Architecture and Data Flow
Triggers, Events, and Actions
Registering your workflows
Triggers
Events
Actions
Targeting Devices
Interactions

SDK Action APIs

Say and Listen
Translate
Location (API)
Location Triggers
Device Info (API)
LEDs
Vibration
Notifications
Incidents
Calling
Variables
Debug Logging
Timers
Groups
Custom Audio
NFC Tags
Using Analytics
Helper Methods

Developing with the SDK

Debugging Your Workflows
Using the CLI
Using Dash (web console)
Best Practices
Built-in Voice Commands

SDK API Reference

Node.js
Java
Python
.Net
Golang

Relay HTTP APIs

Auth for HTTP APIs
HTTP Trigger
Device Info (HTTP)

SDK Cloud Hosting & Deployment

Hosting Overview
ngrok
Heroku
Amazon AWS EC2

SDK Migration

Workflows 1.x to 2.x

Powered by

Node.js

The Node.js API reference is at https://relaypro.github.io/relay-js .

Updated 12 months ago