Description
PeakURL connects a WordPress site to PeakURL with a bearer API key.
With the plugin enabled, editors and admins can:
- connect WordPress to a PeakURL install from the WordPress admin
- create or update a PeakURL link for posts, pages, and supported custom post types
- copy the generated short URL from the editor or posts list
- open the matching PeakURL dashboard screen for an existing short link
- bulk sync selected posts from the posts list
- optionally delete the remote PeakURL link when content is permanently deleted in WordPress
PeakURL stores the configured API key encrypted in the WordPress options table and uses the PeakURL API with bearer-token authentication.
Learn more and see the setup guide in the PeakURL for WordPress docs.
External services
This plugin connects to the PeakURL API URL that you configure in the plugin settings. It uses that API to test the connection from WordPress and to create, update, and optionally delete short links for supported content.
The plugin does not send data to PeakURL until you enter an API URL and API key and then use one of the plugin’s connection or sync actions.
Requests are sent when you:
- run
Test Connection - manually sync content from the editor
- bulk sync selected content from the posts list
- save published content while automatic sync is enabled
- permanently delete content while remote deletion is enabled
When the plugin connects, it sends:
- your PeakURL bearer API key in the
Authorizationheader - the WordPress permalink, link title, and optional custom alias when creating or updating a short link
- the stored PeakURL link ID when updating or deleting an existing short link
For the plugin-specific privacy notice, see:
If you connect the plugin to the managed PeakURL.com service, the same request data is sent to that configured PeakURL API.
If you connect the plugin to a self-hosted PeakURL install, the same data is sent to the API URL you configure for that install. Self-hosted deployments are operated by you or your chosen host, so their own terms and privacy policy apply.
Screenshots
PeakURL settings screen in the WordPress admin. 
PeakURL panel in the post and page editor for creating or updating a short link. 
PeakURL short URL column and quick actions in the posts list.
Installation
- Upload the
peakurlfolder to the/wp-content/plugins/directory, or install the plugin through the WordPress plugins screen. - Activate the plugin through the
Pluginsscreen in WordPress. - Open the
PeakURLmenu item in the WordPress admin. - Enter the PeakURL API URL, that you can get from the PeakURL dashboard settings API Keys.
- Create an API key in your PeakURL dashboard and paste it into the plugin settings.
- Save the settings and use
Test Connectionto confirm the site can connect.
FAQ
-
Where do I find the base API URL?
-
You can find that from the PeakURL dashboard Settings > API Keys.
-
Where do I get the API key?
-
Create the key in your PeakURL dashboard from
Settings -> API Keys. -
Which content types are supported?
-
PeakURL supports posts, pages, and supported public custom post types that you enable in the plugin settings.
-
Where can I learn more about setup and usage?
-
Read the full PeakURL for WordPress documentation.
-
Can I update an existing PeakURL link instead of creating duplicates?
-
Yes. Once a post already has a connected PeakURL link, the plugin updates that link in place.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“PeakURL” is open source software. The following people have contributed to this plugin.
Contributors
Translate “PeakURL” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.0
- Initial release.