CONNECT APP
Build with Readwise
Developer Tools
- API key
MCP
Give your agent Readwise tools
Every Readwise action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Readwise account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "readwise",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Get Highlight Details:
const result = await mcp.callTool({
name: "readwise-get-highlight-details",
arguments: {
bookId: 10,
highlightId: 10,
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "readwise",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Get Highlight Details:
result = await session.call_tool("readwise-get-highlight-details", {
"bookId": 10,
"highlightId": 10,
})API PROXY
Call the Readwise API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Readwise API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://readwise.io/api/v2/books/",
})
// Any allowed Readwise endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://readwise.io/api/v2/books/
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9yZWFkd2lzZS5pby9hcGkvdjIvYm9va3Mv?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Readwise actions from your backend
Connect a user's Readwise account once, then run Get Highlight Details on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "readwise-get-highlight-details",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
readwise: { authProvisionId: "apn_xxxxxxx" },
bookId: 10,
highlightId: 10,
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="readwise-get-highlight-details",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"readwise": {"authProvisionId": "apn_xxxxxxx"},
"bookId": 10,
"highlightId": 10,
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "readwise-get-highlight-details",
"configured_props": {
"readwise": { "authProvisionId": "apn_xxxxxxx" },
"bookId": 10,
"highlightId": 10
}
}'TOOLS
Readwise actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Get Highlight Details
actionGet Highlight´s Details See the docs hereRead-onlyv0.0.4 -
List Book Id Options
actionRetrieves available options for the Book Id field.Read-onlyv0.0.1 -
List Highlights
actionA list of highlights with a pagination metadata. The rate limit of this endpoint is restricted to 20 requests per minute. Each request returns 1000 items. See the docs hereRead-onlyv0.0.5
EVENTS
Readwise triggers
Event sources your backend can deploy for users and receive through a webhook.
MULTI-APP
Use Readwise with other popular apps
Most products don't stop at one integration. Pair Readwise with the other apps your users rely on, and ship use cases that span both.
- App slug
- readwise
- Authentication
- API key
- Categories
- Developer Tools
- Actions
- 3
- Triggers
- 2
- API proxy
- Available