Connectors Reference

Inoreader

Inoreader is a content reader built for power users. Use Inoreader to subscribe to feeds, read articles or catalogue them for viewing later.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

AddSubscription (AddSubscriptionParameterBody body)

Add subscription

EditSubscription (string streamId, EditSubscriptionParameterBody body)

Edit subscription

UnsubscribeSubscription (string streamId)

Unsubscribe subscription

RemoveSubscriptionFromFolder (string streamId, string tagId)

Remove a subscription from a folder

AddSubscriptionToFolder (string streamId, string tagId)

Add a subscription to a folder

DeleteTag (string tagId)

Delete tag

GetUnreadCountForStream (string streamId)

Get number of unread items in a stream

GetUnreadCount ()

Get number of unread items

GetSubscriptions ()

Get subscriptions

GetTags ()

Get tag list

StreamContents (string streamId, [Optional]integer n)

Stream contents

 

Triggers:

Name

Summary

OnNewSubscription ()

When a new subscription is added

OnUnreadItemCountForStreamExceedsTarget (string streamId, integer target)

When unread count reaches a target

 

Objects:

Name

Summary

AddSubscriptionParameterBody

 

AddSubscriptionResponse

 

EditSubscriptionParameterBody

 

GetSubscriptions_Response

 

StreamContentsResponseItem

 

Subscription

 

Tag

 

UnreadCount

 

 

Actions:

AddSubscription

Summary: Add subscription

Description: Add a new subscription.

 

Syntax:

Inoreader.AddSubscription (AddSubscriptionParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

AddSubscriptionParameterBody

 

 

True

 

Returns:

          Type:AddSubscriptionResponse

 

EditSubscription

Summary: Edit subscription

Description: Edit the information for a specific subscription.

 

Syntax:

Inoreader.EditSubscription (string streamId, EditSubscriptionParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

streamId

string

(Subscription Id)

 

True

GetSubscriptions

body

EditSubscriptionParameterBody

 

 

True

 

Returns:

          Type:string

 

UnsubscribeSubscription

Summary: Unsubscribe subscription

Description: Unsubscribe from a subscription.

 

Syntax:

Inoreader.UnsubscribeSubscription (string streamId)

 

Parameters:

Name

Type

Summary

Required

Related Action

streamId

string

(Subscription Id)

 

True

GetSubscriptions

 

Returns:

          Type:string

 

RemoveSubscriptionFromFolder

Summary: Remove a subscription from a folder

Description: Remove a subscription from a specific folder.

 

Syntax:

Inoreader.RemoveSubscriptionFromFolder (string streamId, string tagId)

 

Parameters:

Name

Type

Summary

Required

Related Action

streamId

string

(Subscription Id)

 

True

GetSubscriptions

tagId

string

(Folder Id)

 

True

GetTags

 

Returns:

          Type:string

 

AddSubscriptionToFolder

Summary: Add a subscription to a folder

Description: Add a subscription to a specific folder.

 

Syntax:

Inoreader.AddSubscriptionToFolder (string streamId, string tagId)

 

Parameters:

Name

Type

Summary

Required

Related Action

streamId

string

(Subscription Id)

 

True

GetSubscriptions

tagId

string

(Folder Id)

 

True

GetTags

 

Returns:

          Type:string

 

DeleteTag

Summary: Delete tag

Description: Delete a tag from the account.

 

Syntax:

Inoreader.DeleteTag (string tagId)

 

Parameters:

Name

Type

Summary

Required

Related Action

tagId

string

(Tag Id)

The full tag name, like user/-/label/Tech

True

GetTags

 

Returns:

          Type:string

 

GetUnreadCountForStream

Summary: Get number of unread items in a stream

Description: Get the number of unread items for a specific stream.

 

Syntax:

Inoreader.GetUnreadCountForStream (string streamId)

 

Parameters:

Name

Type

Summary

Required

Related Action

streamId

string

(Subscription Id)

 

True

GetSubscriptions

 

Returns:

          Type:UnreadCount

 

GetUnreadCount

Summary: Get number of unread items

Description: Get the number of unread items across all streams.

 

Syntax:

Inoreader.GetUnreadCount ()

 

Returns:

          Type:array of (UnreadCount)

 

GetSubscriptions

Summary: Get subscriptions

Description: Get a list of subscriptions.

 

Syntax:

Inoreader.GetSubscriptions ()

 

Returns:

          Type:array of (GetSubscriptions_Response)

 

GetTags

Summary: Get tag list

Description: Get a list of tags.

 

Syntax:

Inoreader.GetTags ()

 

Returns:

          Type:array of (Tag)

 

StreamContents

Summary: Stream contents

Description: Lists the articles for a given collection.

 

Syntax:

Inoreader.StreamContents (string streamId, [Optional]integer n)

 

Parameters:

Name

Type

Summary

Required

Related Action

streamId

string

(Subscription Id)

 

True

GetSubscriptions

n

integer

(Number of items)

Number of items to return (default 20, max 1000).

False

 

Returns:

          Type:array of (StreamContentsResponseItem)

 

Triggers:

Trigger OnNewSubscription

Summary: When a new subscription is added

Description: Triggers when a new subscription is added to your account.

 

Syntax:

Inoreader.OnNewSubscription ()

 

Returns:

          Type:array of (Subscription)

 

Trigger OnUnreadItemCountForStreamExceedsTarget

Summary: When unread count reaches a target

Description: Triggers when the number of unread items for a subscription reaches or exceeds the target value.

 

Syntax:

Inoreader.OnUnreadItemCountForStreamExceedsTarget (string streamId, integer target)

 

Parameters:

Name

Type

Summary

Required

Related Action

streamId

string

(Subscription Id)

 

True

GetSubscriptions

target

integer(int32)

(Target Count)

The target number of unread items.

True

 

Returns:

          Type:UnreadCount

 


 

AddSubscriptionParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

quickadd

string

 

ID of the stream to add, , e.g. feed/http://feeds.arstechnica.com/arstechnica/science


 

AddSubscriptionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

numResults

boolean

 

Whether adding the subscription was successful.

streamId

string

 

The Id of the stream.

streamName

string

 

The name of the stream.


 

EditSubscriptionParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

t

string

 

The title of the subscription.


 

GetSubscriptions_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The feed identifier.

title

string

 

The title of the feed.

sortid

string

 

 

timestamp

string(date-time)

 

A timestamp of the first item in the feed.

url

string

 

Actual XML URL of the feed.

htmlUrl

string

 

The link to the feed website.

iconUrl

string

 

The feed favicon in 16x16 pixels.


 

StreamContentsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

author

string

 

 

url

string

 

 

id

string

 

 

published

string

 

yyyy-MM-ddTHH:mm:ss.fffZ

summary

Summary

 

summary

timestamp

string(date-time)

 

A timestamp of the newest item.

title

string

 

 

updated

string

 

yyyy-MM-ddTHH:mm:ss.fffZ

 

Summary

Summary:

Description: summary

 

          Properties:

Name

Type

Summary

content

string

 

 

direction

string

 

 

 


 

Subscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The feed identifier.

title

string

 

The title of the feed.

categories

array of (CategoriesItem)

 

 

sortid

string

 

 

timestamp

string(date-time)

 

A timestamp of the first item in the feed.

url

string

 

Actual XML URL of the feed.

htmlUrl

string

 

The link to the feed website.

iconUrl

string

 

The feed favicon in 16x16 pixels.

 

CategoriesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The identifier of the category.

label

string

 

The label of the category.

 


 

Tag

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Unique tag id.

sortid

string

 

Id for sorting.

niceTitle

string

 

Title


 

UnreadCount

Summary:

Description:

 

          Properties:

Name

Type

Summary

count

integer(int32)

 

The count of unread items.

timestamp

string(date-time)

 

A timestamp of the newest item.