Demo to preview the settings

Introduction

Supply a URL and this plugin will return a title, description, and image from that site so that you can generate link previews in your app.

Prerequisites

  1. You must have the Linkpreview account.

How to set up

Getting your API keys

Follow this link to create or log into your existing LinkPreview account.
Once you've successfully registered, you'll be taken to your dashboard where you'll find your API key:
Image without caption
Copy this key and paste it into the plugin settings:
Image without caption
Once you've completed the above steps, head over to the next page to set up your design and perform the API call.

Using the API Call

Create your design

Here's a quick example of the design we're using:
Image without caption
In the above example, all groups are nested inside of one group that has the type of content set to Get Preview (Link Preview). This way we can perform the API call once, send the results to this group, and all three visual elements can display the resulting information:
Image without caption

Set up the API call

When setting up the call, we'll want to select the Link Preview - Get Preview action from our list of external API calls:
Select "Get data from an external API" first
Select "Get data from an external API" first
Then select "Link Preview - Get Preview" from the list
Then select "Link Preview - Get Preview" from the list
After you've made the correct selection, place the URL value into the (path) q input.
Image without caption
This is only one of many methods, so this decision is entirely up to you. Get creative!

Changelogs

Update 08.10.24 - Version 1.14.0

  • Changed API response: included errors in the response.

Update 25.07.24 - Version 1.12.0

  • Minor update.

Update 30.05.24 - Version 1.10.0

  • Minor update.

Update 13.09.23 - Version 1.6.0

  • minor updates.

Update 04.10.22 - Version 1.2.0

  • Updated documentation.

Update 18.12.18 - Version 1.1.0

  • Minor change to link parameter placeholder.

Update 25.03.17 - Version 1.0.0

  • v1.