メディアの変更時に他システムとの連携を行うため、microCMSではWebhook機能を用意しています。
設定は「メディア」→「設定」から行います。

Webhookのタイミング

各Webhookの設定時にWebhookを発行するタイミングを設定できます。

メディアの作成時

メディアを新規作成 (新規アップロード) の際に通知を行います。

メディアの更新時

メディアを再アップロード・ファイル名を変更した際に通知を行います。

メディアの削除時

メディアを削除した際に通知を行います。

Webhook通知について

メディアのWebook通知では任意のURLに対してPOSTリクエストを送信します。
あらゆるURLを指定可能ですので、リクエストを受け取った側は独自の処理を自由に行ってください。

リクエスト内容

ヘッダ

リクエストヘッダには Content-Type: application/json が含まれます。

ボディ

リクエストボディには対象となったコンテンツやAPIの情報が含まれます。

{
  service: 'test',
  type: 'new',  // new または update または delete
  old: {
    url: 'https://image.microcms-assets.io/xxxxxx',
    width: 100,
    height: 100,
  },
  new: {
    url: 'https://image.microcms-assets.io/xxxxxx',
    width: 100,
    height: 100,
  },
}

• service - 変更のあったコンテンツが属するサービスのサブドメインが入ります
• type - 変更の種類です。新規追加時はnew、編集時はedit、削除時はdeleteが入ります
• old - メディアの編集前もしくは削除前の内容が含まれます。メディアの新規作成時にはnullが入ります。
• old.url - メディアのurlが含まれます。
• old.width - メディアのwidthが含まれます。ファイルの場合はnullが入ります。
• old.height - メディアのheightが含まれます。ファイルの場合はnullが入ります。
• new - メディアの作成後もしくは編集後の内容が含まれます。メディアの削除時にはnullが入ります。
• new.url - メディアのurlが含まれます。
• new.width - メディアのwidthが含まれます。ファイルの場合はnullが入ります。
• new.height - メディアのheightが含まれます。ファイルの場合はnullが入ります。

セキュリティについて

microCMSからの通知を受け取るサーバは一般公開をしておく必要があります。
そのため一般的には第三者からPOSTリクエストを受ける可能性も考慮した対応を行う必要があります。

具体的にはURLの設定時に?auth=XXX などmicroCMSと受け取り側サーバにしか知り得ない値を設定しておき、
受け取り側のサーバでこの値が正しいかどうか（≒microCMSからのリクエストであるか否か）検証を行ってください。