@keziahmoselle/webhook

Webhook

In development...

Install

npm install @keziahmoselle/webhook

Usage

const Webhook = require('@keziahmoselle/webhook')

Webhook.observe('https://domain.com')

// No changes detected
Webhook.on('nodiff', () => {
  // Do something
})

// Changes detected
Webhook.on('update', (data) => {
  // Do something
  data.now // New content
  data.old // Old content
})

Options

Webhook.observe('https://domain.com', {
  // The URL you want to POST the data
  postUrl: 'https://domain.com/post',
  // The element you want to watch
  // NOTE: `content` is a placeholder for the content you want to watch (it is required)
  element: '<title>content</title>',
  // At which interval you want to scrape ? Default: 5 minutes
  interval: 10*60*1000 // Scrape every 10 minutes
})

API

.observe(url[, options])

url: String (The URL you want to observe)

options: Object

• postUrl String (Send a POST request to postUrl with data as a payload)
• element: String (The element you want to watch)
• interval: Number Default: 5 minutes

If you want to watch the title of a page for example : Note that content will be replaced by the actual content of the web page.

Webhook.observe('https://domain.com', {
  element: '<h1>content</h1>'
})

Webhook.observe('https://domain.com', {
  interval: 60*60*1000 // It will scrape every 1 hour
})

.on('nodiff', function)

Event 'nodiff' is emitted when a website does not change

function

Type: Function

Webhook.on('nodiff', () => {
  console.log('Same content !')
})

.on('update', function)

Event 'update' is emitted when a website change

function

Type: Function

Argument: data (Type: Object)

data.new contains the new content

data.old contains the old content

Webhook.on('update', (data) => {
  console.log(data.now) // 'new content'
  console.log(data.old) // 'old content'
})