Skip to content

Pinboard

With the Pinboard modules, you can create and watch the bookmark in your Pinboard account.

To get started with the Pinboard, create an account at pinboard.com

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connect Pinboard with Ibexa Connect

To connect the Pinboard app with the Ibexa Connect:

  1. Log in to your Pinboard account.

  2. Click Settings > Password and copy the API Key to a safe place.

    Pinboard_4.png

  3. Log in to your Ibexa Connect account and add a module from the Pinboard into a Ibexa Connect scenario.

  4. Click Add next to the Connection field.

  5. In the Connection name field, enter a name for the connection.

  6. In the API Key field enter the details copied in step 2 and click Save.

You have successfully connected the Pinboard app with Ibexa Connect and can now build scenarios.

Bookmarks

You can watch the bookmarks using the following module.

Watch Bookmarks

Watches for new bookmarks.

Limit Set the maximum number of bookmarks Ibexa Connect will return during one execution cycle. The default value is 2.

Create a Bookmark

Creates a new bookmark.

Bookmark URL

Enter (map) the URL address of the item for which you want to create the bookmark.

Description

Enter (map) the bookmark name.

Extended

Enter (map) the bookmark details.

Tags

Select or map the tags. You can list up to 100 tags.

Datetime

Enter (map) creation time for this bookmark. By default, it is the current time. See the list of supported date and time formats.

Datestamps more than 10 minutes ahead of server time reset to the current server time.

Replace

Select whether to replace any existing bookmark with this URL. The default is Yes. If set to No, returns an error if the bookmark exists.

Shared

Select whether make the bookmark public. The default is Yes unless you enable the setting, save all bookmarks as private, then the default value is No.

To Read

Select whether to mark the bookmark as unread. The default is No.

Others

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.pinboard.in .For example, /v1/posts/all.

For the list of available endpoints, refer to the Pinboard API Documentation.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Returns all bookmarks

The following API call returns all bookmarks in your Pinboard account:

URL:

/v1/posts/all

Method:

GET

Pinboard_5.png

Matches of the search can be found in the module's Output under Bundles > Body > posts > post.

In our example, 12 bookmarks were returned:

Pinboard_6.png