Scripting

An incoming webhook can run a script on each article it receives.

Features

This script gives control over a set of features:

• Change the title of the article (setTitle(string))
• Change the text of the article (setText(string))
• Categorize the article (setCategory(string))
• Mark article as read (markAsRead())
• Mark article as to-read (markAsToRead())
• Notify connected devices of the article (sendNotification())
• Call an outgoing webhook (triggerWebhook(string))
• Disable the global notification policy for this webhook (disableGlobalNotification())

The script expects a boolean value in return. This value decides the fate of the article:

• return true;: the article will be integrated
• return false;: the article will be ignored

Note that if the article is ignored then the above features have no effect.

Syntax

You are free to implement the orchestration logic of these actions with a simple syntax.

You can access the following attributes within your script:

• Title: the title of the article
• Text: the text of the article
• HTML: the HTML content of the article
• URL: the URL of the article
• Origin: the article origin
• Tags: the tags and hashtags of the article (string array)

Note that hashtags are extracted from the article title and text, while tags come with the input article. Only hashtags are kept (because they are part of the title and text). Input tags are not kept and are only used by the script. If you want to keep the tags, it’s recommended to include them as hashtags in the title or text.

Examples

Here are some examples to illustrate the possibilities:

Categorize an article according to its tags

if ("news" in Tags) {
    setCategory("News");
}
return true;

Add a prefix to the title

setTitle(sprintf("[From my awesome webhook] %s", Title));
return true;

Send a notification on a particular topic

if ("news" in Tags) {
    setCategory("News");
    if (Title ~= /breaking|important/i) {
        sendNotification();
    }
}
return true;

Filter a topic without interest

if (Title ~= /boring|stupid/i) {
    return false;
}
return true;

Accepting articles from another readflow user

if (Origin == "johndoe@example.com") {
    setTitle(sprintf("[From %s] %s", Origin, Title));
    return true;
}
return false;