Apps
Overview
Apps represent the concrete applications that connect to EnSync via an Integration. Each app can publish and/or consume events and is identified with metadata for UI presentation and operations. Apps are granted least‑privilege permissions and can be managed independently across environments.
App metadata
Name: Human‑readable identifier shown in UIs and logs.
Description: Short summary of the app’s purpose.
Color: Optional brand color used for avatars/badges in UIs.
Icon URL: Optional logo used in UIs (falls back to color/initials if not set).
Metadata (JSON): Arbitrary key‑value attributes for ownership, SLA, routing, or configuration.
Identity and permissions
Unique keys per app and per environment (dev/stage/prod).
Fine‑grained permissions defining which topics/events an app can send and/or receive.
Audit trails and key rotation policies.
Webhooks (optional)
An app may register a webhook endpoint to receive event notifications. Ensure the endpoint is secured and able to verify authenticity.
Typical lifecycle
Register the app (set name/description and optional icon/color/metadata).
Assign permissions (send/receive topics) and provision environment‑specific keys.
Implement publishing/subscribing using SDKs with schema‑validated payloads.
(Optional) Configure webhook and verify delivery.
Monitor performance, errors, and rotate keys per policy.