Document Edge App integrations#296
Open
renatgalimov wants to merge 1 commit into
Open
Conversation
Integration-backed values are settings whose help_text descriptor names a provider; the app fetches credentials at runtime via getCredentials. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for Edge App “Integrations” so developers (and AI agents) can correctly model integration-backed settings and fetch credentials at runtime.
Changes:
- Adds an Integrations entry to the Settings table of contents.
- Documents how to declare integration-backed settings via
help_text.schema_version: 1andhelp_text.properties.type. - Documents runtime credential retrieval returning
{ token, metadata }and references reserved injected settings.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Some Edge Apps show data from a third-party service — a calendar, a Grafana or Power BI dashboard, a Salesforce report. Connecting to those services means authenticating and keeping credentials fresh. **Integrations** hand that work to Screenly: the user connects an account once in the Screenly dashboard, and your Edge App receives ready-to-use credentials at runtime. | ||
|
|
||
| An integration-backed value is just a setting whose `help_text.properties.type` names the provider and the field Screenly should fill, in the form `<provider>:<field>`. The field is either a credential (a token) or a piece of configuration the user chose when connecting the account (which calendar, which dashboard). |
| > Fetching credentials at runtime | ||
|
|
||
| ```js | ||
| const { token, metadata } = await getCredentials(); |
nicomiguelino
approved these changes
Jun 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Edge Apps docs had no integrations reference. Without it, AI agents produce complete nonsense when wiring up a connected service.
Adds an Integrations section under Settings: an integration-backed value is a setting whose
help_text.properties.typenames the provider and field (<provider>:<field>), andgetCredentials()returns{ token, metadata }at runtime.🤖 Generated with Claude Code