Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tidyread.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Webhooks feature allows you to push digest data to a webhook when building a digest in Tidyread. For example, you can use this feature to send digest to platforms like Telegram and Lark.

​
Webhook Types

Tidyread currently supports the following webhook types:
  • Telegram: Send digest to a Telegram chat.
  • Lark(Feishu): Send digest to a Lark chat.
  • DingTalk: Send digest to a DingTalk chat.
  • Discord: Send digest to a Discord channel.
  • Customized: Send digest to any webhook link.

​
Webhook Payload

You can specify the payload JSON structure to be sent to the webhook link. If you don’t provide one, the following data structure will be sent by default: 

type Payload = {
  blocks: BlockItem[]
  // Digest title
  title: string
}

type BlockItem = {
  title?: string
  summary?: string
  url?: string
  source?: string
  tags?: string[]
  pubDate?: string
  serialNumber?: number
}

​
Template

The template is used to customize the rendering structure of individual messages in the Digest. You can use the following variables: 
{{title}}  // item title
{{summary}} // item summary
{{url}} // item url
{{source}} // item source, e.g., Hacker News
{{pubDate}} // item publish date, e.g., 2024-02-14 22:30
{{serialNumber}} // item serial number in the digest

​
Troubleshooting

If you notice that digest messages are not being pushed as expected, try clicking the Test Webhook button to check if the configuration is correct. If there’s an error, an error message will pop up. If you’re unable to resolve the issue, please use the feedback button in the extension sidebar to report the problem to us.