Create Custom Field with HeroBot Chatbot Marketing API on New Highlights from Readwise API

Pipedream makes it easy to connect APIs for HeroBot Chatbot Marketing, Readwise and 2,700+ other apps remarkably fast.

Trigger workflow on

New Highlights from the Readwise API

Next, do this

Create Custom Field with the HeroBot Chatbot Marketing API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Readwise trigger and HeroBot Chatbot Marketing action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Highlights trigger
1. Connect your Readwise account
2. Configure Polling interval
3. Optional- Select a Book Id
Configure the Create Custom Field action
1. Connect your HeroBot Chatbot Marketing account
2. Configure Name
3. Select a Type
4. Configure Description
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Highlights on Readwise

Description:Emit new Highlight

Version:0.0.5

Key:readwise-new-highlights

View on GitHub

Readwise Overview#

The Readwise API allows you to access and manipulate your Readwise data, which includes highlights, notes, and books from your reading list. With this API, you can automate the retrieval of your reading highlights, synchronize them across various platforms, or trigger custom actions based on new highlights added. Pipedream, as a serverless integration and compute platform, enables you to create workflows that leverage the Readwise API to build powerful automations, connecting your reading insights to countless other apps and services to enrich productivity and data management.

Trigger Code#

import readwise from "../../readwise.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "readwise-new-highlights",
  name: "New Highlights",
  description: "Emit new Highlight",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    readwise,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Readwise API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    bookId: {
      propDefinition: [
        readwise,
        "bookId",
      ],
      optional: true,
    },
  },
  hooks: {
    async activate() {
      await this.processHighlighs({
        book_id: this.bookId,
        page_size: 25,
      });
    },
  },
  methods: {
    _getLastHighlightedAt() {
      return this.db.get("lastHighlightedAt");
    },
    _setLastHighlightedAt(lastHighlightedAt) {
      this.db.set("lastHighlightedAt", lastHighlightedAt);
    },
    async retrieveTicket(id) {
      return this.readwise.retrieveTicket({
        id,
      });
    },
    async processHighlighs(params) {
      const { results: events } = await this.readwise.listHighlights({
        params,
      });
      for (const event of events) {
        this.emitEvent(await this.readwise.getHighlight({
          highlightId: event.id,
        }));
      }
    },
    async processEvent() {
      const lastHighlightedAt = this._getLastHighlightedAt();
      await this.processHighlighs({
        book_id: this.bookId,
        highlighted_at__gt: lastHighlightedAt,
      });
    },
    emitEvent(event, lastHighlightedAt = null) {
      lastHighlightedAt = lastHighlightedAt || this._getLastHighlightedAt();

      if (!lastHighlightedAt || (new Date(event.highlighted_at) > new Date(lastHighlightedAt)))
        this._setLastHighlightedAt(event.highlighted_at);

      const ts = Date.parse(event.highlighted_at);
      this.$emit(event, {
        id: `${event.id}_${ts}`,
        ts,
        summary: `New highlight: ${event.id}`,
      });
    },
  },
  async run() {
    console.log("Raw received event:");
    return this.processEvent();
  },
};

Trigger 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.

Label	Prop	Type	Description
Readwise	`readwise`	`app`	This component uses the Readwise app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Readwise API on this schedule
Book Id	`bookId`	`integer`	Select a value from the drop down menu.

Trigger Authentication#

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

About Readwise#

Readwise makes it easy to revisit and learn from your ebook & article highlights.

Action#

Create Custom Field on HeroBot Chatbot Marketing

Description:Create a new custom field in the HeroBot account. [See the documentation](https://my.herobot.app/api/swagger/#/Accounts/createCustomField)

Version:0.0.1

Key:herobot_chatbot_marketing-create-custom-field

View on GitHub

HeroBot Chatbot Marketing Overview#

The HeroBot Chatbot Marketing API lets you interact with the HeroBot platform to manage and deliver chatbot services. With this API, you can automate conversations, broadcast messages, and gather insights from chatbot interactions. Pipedream's serverless platform enables you to create workflows integrating HeroBot with other apps, triggering actions based on events, and processing data without managing infrastructure.

Action Code#

import app from "../../herobot_chatbot_marketing.app.mjs";

export default {
  key: "herobot_chatbot_marketing-create-custom-field",
  name: "Create Custom Field",
  description: "Create a new custom field in the HeroBot account. [See the documentation](https://my.herobot.app/api/swagger/#/Accounts/createCustomField)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the custom field.",
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the custom field.",
      options: [
        {
          label: "Text",
          value: "0",
        },
        {
          label: "Number",
          value: "1",
        },
        {
          label: "Date (Unix timestamp)",
          value: "2",
        },
        {
          label: "Datetime (Unix timestamp)",
          value: "3",
        },
        {
          label: "Boolean",
          value: "4",
        },
      ],
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the custom field.",
    },
  },
  async run({ $ }) {
    const response = await this.app.createCustomField({
      $,
      data: {
        name: this.name,
        type: parseInt(this.type),
        description: this.description,
      },
    });

    $.export("$summary", `Successfully created custom field ${this.name}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
HeroBot Chatbot Marketing	`app`	`app`	This component uses the HeroBot Chatbot Marketing app.
Name	`name`	`string`	The name of the custom field.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Text", "value": "0" }{ "label": "Number", "value": "1" }{ "label": "Date (Unix timestamp)", "value": "2" }{ "label": "Datetime (Unix timestamp)", "value": "3" }{ "label": "Boolean", "value": "4" }`
Description	`description`	`string`	The description of the custom field.

Try it

Create User with HeroBot Chatbot Marketing API on New Documents from Readwise API

Readwise + HeroBot Chatbot Marketing

Try it

Create User with HeroBot Chatbot Marketing API on New Highlights from Readwise API

Readwise + HeroBot Chatbot Marketing

Try it

Send Message with HeroBot Chatbot Marketing API on New Documents from Readwise API

Readwise + HeroBot Chatbot Marketing

Try it

Send Message with HeroBot Chatbot Marketing API on New Highlights from Readwise API

Readwise + HeroBot Chatbot Marketing

Try it

Popular Triggers#

New Documents from the Readwise API

Emit new document See the documentation

Try it

New Highlights from the Readwise API

Emit new Highlight

Try it

New Tag Added from the HeroBot Chatbot Marketing API

Emit new event when a new tag is added to a specific user.

Try it

New User Created from the HeroBot Chatbot Marketing API

Emit new event when a new user is created.

Try it

Popular Actions#

Get Highlight Details with the Readwise API

Get Highlight´s Details See the docs here

Try it

List Highlights with the Readwise API

A 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 here

Try it

Create Custom Field with the HeroBot Chatbot Marketing API

Create a new custom field in the HeroBot account. See the documentation

Try it

Create User with the HeroBot Chatbot Marketing API

Saves pertinent information about a new user. See the documentation

Try it

Send Message with the HeroBot Chatbot Marketing API

Sends a message to a user through the chatbot. See the documentation

Try it