Preview URL
matrix.get_url_preview
ActionChat & messagingconnection required
Calls the Matrix API with the connection's credentials.
Ask the homeserver for the OpenGraph preview of a web page.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Matrix
- Secret shape
- the account access token, or {"access_token": "…"}
- Config it needs
- base_url, user_id, default_room_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
url The page to preview. | string | Yes | — | url format | — |
ts Preview the page as it was at this time, in milliseconds since the epoch. | number | No | — | ≥ 0 | — |
Output
One shape.
result
The provider's response object, as returned.
Extra keys beyond the ones listed can appear.
{}Notes
- The connection's base_url is the homeserver (e.g. https://matrix.example.org), not the account's server name; the two differ whenever .well-known delegation is in use.
- Rooms are addressed by room id (!abc:server). Resolve a #alias:server with matrix.resolve_room_alias first, or set a default room on the connection.
- The response keys are OpenGraph names such as 'og:title' and 'og:image', plus 'matrix:image:size'.
- Uses the authenticated media API, which homeservers implement from Matrix 1.11; an older homeserver answers 404 here.
See Preview URL run in a workflow.
In a technical demo we add the Matrix connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.