Webhook教程

一、什麼是Webhook

Webhook是一種API，應用程序可以使用Webhook來自動化、擴展和通知其他應用程序。

在Webhook模型中，當某個事件發生時，會將信息傳遞給其他應用程序（Webhook）。

Webhook通常用於自動化、集成和發送通知。當一些特定事件發生時，Webhook可以發送具有有關該事件的信息。

示例代碼：

router.post('/webhook', (req, res) => {
  const { body } = req
  // 根據 body 做一些事情
  res.send(`Webhook received: ${body}`);
});

二、Webhook的優點

使用Webhook有以下幾個優點：

1. 實時性

當某個事件發生時，Webhook的推送會實時接收到，保證了信息的時效性。

2. 自動化

Webhook可以自動化完成一些重複的工作，例如自動化部署、數據同步等等。

3. 安全性

Webhook相比傳統API調用更有安全性，因為Webhook只允許以推送的方式訪問API，不允許以拉取的方式訪問API，可以減少API濫用的風險。

示例代碼：

const githubWebhook = require('express-github-webhook');
app.use(githubWebhook({ secret: 'MySecretKey' }));
app.post('/webhook', (req, res) => {
  const { body } = req;
  // 根據 body 做一些事情
  res.sendStatus(200);
});

三、Webhook的應用場景

Webhook可以應用於很多場景，以下是幾個常見的應用場景：

1. 自動化部署

當代碼合併到主分支時，使用Webhook可以實現自動化部署，節省了人工部署的時間和精力。

2. 數據同步

使用Webhook可以實現數據的自動同步。以電商為例，當訂單狀態發生變化時，Webhook會推送最新的訂單狀態到其他系統，如ERP系統、物流系統等等，實現數據的同步。

3. 通知推送

Webhook可以作為通知系統使用，當某些事件發生時，Webhook會將信息推送給訂閱的應用程序，如郵件、簡訊、Slack等。

示例代碼：

const axios = require('axios')
axios.post('https://api.webhook.site/{webhook-url}', {
  message: 'Hello Webhook'
}).then(response => {
  console.log(response.data)
}).catch(error => {
  console.error(error)
});

四、Webhook的實現

實現Webhook有幾個基本步驟：

1. 創建Webhook

創建Webhook需要提供一些基本信息，如Webhook的名稱、觸發事件、Webhook的URL等等。

2. 接收Webhook的請求

當Webhook觸發時，應用程序需要接收到Webhook的請求。通常是使用HTTP協議來接收請求。

3. 處理Webhook請求

根據Webhook請求中的信息，應用程序可以做出相應的響應。通常是將請求中的信息進行處理或者保存到資料庫中。

示例代碼：

// 創建Webhook
// 在Github倉庫中設置Webhook
// Payload URL: https://example.com/webhook
// Content type: application/json
// Secret: MySecretKey
// Which events would you like to trigger this webhook? Just the push event.
// Active: √

router.post('/webhook', (req, res) => {
  const { headers, body } = req
  const { name } = headers['x-github-event']
  switch (name) {
    case 'push':
      const { commits } = body
      commits.forEach((commit) => {
        // 處理commit信息
      })
      break
    default:
      // 處理其他事件
      break
  }
  res.send('Webhook Received')
});