Getting Started
Integration Architecture
Data flow
RELAY processes and delivers transaction data through a four-stage pipeline:
Event generation: Access EPOS applications generate transaction events (sales, wastage, table movements)
Stream collection: Raw event data streams to Azure Service Bus for processing
Transformation: RELAY filters and enriches data, removing unnecessary information
Delivery: Transformed events POST to configured webhook endpoints via HTTPS
Delivery mechanism
All data delivery occurs through HTTPS POST requests with the following specifications:
Protocol
HTTPS POST Request
Encoding
UTF-8 JSON
Content Type
Delivery guarantee
At-least-once
Retry behaviour
Exponential backoff (3 retries maximum)
Connection requirements
Webhook endpoint requirements
Your webhook endpoint must meet the following requirements:
HTTPS with valid TLS certificate (TLS v1.2 or higher)
Public or Azure-accessible URL
Response time under 30 seconds (5 seconds recommended)
Return HTTP 200-299 status for successful receipt
Asynchronous processing to prevent timeouts
Authentication methods
RELAY supports two authentication methods for webhook delivery:
Azure AD OAuth 2.0 (recommended)
OAuth 2.0 provides the most secure authentication method with automatic token management and refresh capabilities.
Prerequisites:
Azure AD tenant with application registration
Client ID and client secret
Configured redirect URI
Configuration requirements:
Token endpoint URL
Scope definitions
Token refresh interval (recommended: every 50 minutes for 60-minute tokens)
API key authentication
API key authentication provides straightforward implementation through custom HTTP headers.
Implementation:
Configuration requirements:
Custom header name (e.g.,
X-API-Key,Authorization)API key value
Header value format (Bearer token, plain key, etc.)
Last updated
Was this helpful?