← Roam Research

Write with Roam Research API

Pipedream makes it easy to connect APIs for Roam Research and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Write with the Roam Research API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Write with the Roam Research API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Write action
    1. Connect your Roam Research account
    2. Select a Action
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Write with Roam Research API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Roam Research
 
Try it
Write with Roam Research API on New Submission from Typeform API
Typeform + Roam Research
 
Try it
Write with Roam Research API on New Submission (Instant) from Jotform API
Jotform + Roam Research
 
Try it
Write with Roam Research API on New Scheduled Tasks from Pipedream API
Pipedream + Roam Research
 
Try it
Write with Roam Research API on New Download Counts from npm API
npm + Roam Research
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Write on Roam Research
Description:Generic write for Roam Research pages. [See the documentation](https://roamresearch.com/#/app/developer-documentation/page/mdnjFsqoA).
Version:0.0.1
Key:roamresearch-write

Code

import app from "../../roamresearch.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "roamresearch-write",
  name: "Write",
  description: "Generic write for Roam Research pages. [See the documentation](https://roamresearch.com/#/app/developer-documentation/page/mdnjFsqoA).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    action: {
      type: "string",
      label: "Action",
      description: "The action to run. Eg. `create-block`.",
      options: Object.values(constants.ACTION),
      reloadProps: true,
    },
  },
  additionalProps() {
    const { action } = this;

    if (action === constants.ACTION.CREATE_BLOCK) {
      return {
        location: {
          type: "object",
          label: "Location",
          description: "The location to create the block where `order` is required and either `parent-uid` or `page-title` is required.",
          default: {
            ["parent-uid"]: "optional",
            ["page-title"]: "optional",
            order: "last",
          },
        },
        block: {
          type: "object",
          label: "Block",
          description: "The block to create where `string` is required.",
          default: {
            string: "required",
            uid: "optional",
            open: "optional",
            heading: "optional",
            ["text-align"]: "optional",
            ["children-view-type"]: "optional",
          },
        },
      };
    }

    if (action === constants.ACTION.MOVE_BLOCK) {
      return {
        location: {
          type: "object",
          label: "Location",
          description: "The location to move the block where `order` is required and either `parent-uid` or `page-title` is required.",
          default: {
            ["parent-uid"]: "optional",
            ["page-title"]: "optional",
            order: "last",
          },
        },
        block: {
          type: "object",
          label: "Block",
          description: "The block to move where `uid` is required.",
          default: {
            uid: "required",
          },
        },
      };
    }

    if (action === constants.ACTION.UPDATE_BLOCK) {
      return {
        block: {
          type: "object",
          label: "Block",
          description: "The block to update where `uid` is required.",
          default: {
            uid: "required",
            string: "optional",
            open: "optional",
            heading: "optional",
            ["text-align"]: "optional",
            ["children-view-type"]: "optional",
          },
        },
      };
    }

    if (action === constants.ACTION.DELETE_BLOCK) {
      return {
        block: {
          type: "object",
          label: "Block",
          description: "The block to delete where `uid` is required.",
          default: {
            uid: "required",
          },
        },
      };
    }

    if (action === constants.ACTION.CREATE_PAGE) {
      return {
        page: {
          type: "object",
          label: "Page",
          description: "The page to create where `title` is required.",
          default: {
            title: "required",
            uid: "optional",
            ["children-view-type"]: "optional",
          },
        },
      };
    }

    if (action === constants.ACTION.UPDATE_PAGE) {
      return {
        page: {
          type: "object",
          label: "Page",
          description: "The page to update where `uid` is required.",
          default: {
            uid: "required",
            title: "optional",
            ["children-view-type"]: "optional",
          },
        },
      };
    }

    if (action === constants.ACTION.DELETE_PAGE) {
      return {
        page: {
          type: "object",
          label: "Page",
          description: "The page to delete where `uid` is required.",
          default: {
            uid: "required",
          },
        },
      };
    }

    if (action === constants.ACTION.BATCH_ACTIONS) {
      return {
        actions: {
          type: "string[]",
          label: "Actions",
          description: "The actions to run in batch. Eg. `{ \"action\": \"create-block\", \"location\": {...}, \"block\": {...} }`",
        },
      };
    }

    return {};
  },
  async run({ $ }) {
    const {
      app,
      action,
      location,
      block,
      page,
      actions,
    } = this;

    const response = await app.write({
      $,
      data: {
        action,
        location,
        block,
        page,
        actions: utils.parseArray(actions),
      },
    });

    $.export("$summary", "Successfully ran the action.");
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Roam ResearchappappThis component uses the Roam Research app.
ActionactionstringSelect a value from the drop down menu:create-blockmove-blockupdate-blockdelete-blockcreate-pageupdate-pagedelete-pagebatch-actions

Authentication

Roam Research uses API keys for authentication. When you connect your Roam Research account, Pipedream securely stores the keys so you can easily authenticate to Roam Research APIs in both code and no-code steps.

About Roam Research

A note-taking tool for networked thought.

More Ways to Use Roam Research

Triggers

New Modified Linked Reference from the Roam Research API

Emit new event for each new or modified linked reference in Roam Research.

 
Try it

Actions

Add Content To Daily Note Page with the Roam Research API

Adds content as a child block to a daily note page in Roam Research (access to encrypted and non encrypted graphs). See the documentation.

 
Try it
Add Content To Page with the Roam Research API

Add content as a child block to an existing or new page in Roam Research (access to encrypted and non encrypted graphs). See the documentation.

 
Try it
Add Content Underneath Block with the Roam Research API

Add content underneath an existing block in your Roam Research graph (access to encrypted and non encrypted graphs). See the documentation

 
Try it
Append Blocks with the Roam Research API

Generic append blocks for Roam Research pages. See the documentation.

 
Try it
Get Page Or Block Data with the Roam Research API

Get the data for a page or block in Roam Research (access only to non ecrypted graphs). See the documentation.

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.