Webhook を設定する

最終更新日: 2024年07月17日

Webhook を設定すると、変更があった際に HTTP リクエストを受け取れます。

Webhook URL を登録する

はじめに、 MonCargo からリクエストを送信する Webhook URL を登録する必要があります。「API 設定」画面から設定してください。

また、下記のように API 経由で設定することも可能です( https://example.com/api/moncargo-webhook は適宜変更してください)。

curl -XPATCH https://api.moncargo.io/v1/me \
    -u api:YOUR_API_KEY \
    -H 'Content-Type: application/json' \
    -d '{
      "webhookUrl": "https://example.com/api/moncargo-webhook"
    }'

Webhook を受け取る

Webhook URL が設定されている場合、 MonCargo は船荷に変更があったときに、通知を送信します。

ℹ️ 通知条件

Webhook が送信されるタイミングや発火条件は、 Webhook URL を設定したユーザーのメール通知設定と同一となります。

以下は Node.js (Fastify) で通知を受け取るコード例です。

import Fastify from 'fastify'

const app = Fastify()

app.post('/api/moncargo-webhook', (request, reply) => {
  console.log(request.body.event)
  // => 'STATUS_CHANGED'

  console.log(request.body.shipment.eta)
  // => '2023-05-08T10:20:00'

  reply.send('ok')
})

app.listen()

MonCargo が送信する通知の内容は、以下の通りです。

key	説明
event	Webhook の内容。現在は `STATUS_CHANGED` のみとなります。
shipment	船荷の情報。詳細は「船荷を扱う」章のレスポンスを参考にしてください。

また、 MonCargo からのリクエストに対し、ステータスコード 200 を返すようにしてください。

Webhook をテストする

Webhook が正常に受け取れているかをテストする場合は、下記のリクエストを送信してください。(00000000-0000-0000-0000-000000000000 は実際の船荷IDを入れてください)。変更の有無に拘らず、 Webhook が送信されます。

curl -XPOST https://api.moncargo.io/v1/shipments/00000000-0000-0000-0000-000000000000/webhook_dispatch \
    -u api:YOUR_API_KEY