メディアを変更（作成／更新／削除）したタイミングで、Webhook通知を行うことができます。
「メディア管理」→「メディア設定」から設定可能です。

Webhookのタイミング

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

メディアの作成時

管理画面でメディアを新規作成（新規アップロード）したときに通知を行います。

メディアの更新時

管理画面でメディアを再アップロードしたとき／ファイル名を変更したときに通知を行います。

メディアの削除時

管理画面でメディアを削除したときに通知を行います。

Webhook通知について

メディアのWebhook通知では、任意のURLに対してPOSTリクエストを送信します。リクエストを受け取った先にて、独自の処理を行うことが可能です。

リクエスト内容

ヘッダ

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

ボディ

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

{
  "service": "someId",
  "type": "edit",
  "old": {
    "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/zzzz.jpg",
    "width": 100,
    "height": 100,
    "alt": "Some sample alt text."
  },
  "new": {
    "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/zzzz.jpg",
    "width": 100,
    "height": 100,
    "alt": "Some sample alt text."
  },
}

service

変更のあったメディアが属するサービスのサブドメインが入ります。

type 

変更の種類です。新規追加時はnew、編集時はedit、削除時はdeleteが入ります。

old

メディアの編集前もしくは削除前の内容が含まれます。メディアの新規作成時にはnullが入ります。

new

メディアの作成後もしくは編集後の内容が含まれます。メディアの削除時にはnullが入ります。

old / new共通

url

メディアのurlが含まれます。

width

メディアのwidthが含まれます。画像以外のファイルの場合はnullが入ります。

height

メディアのheightが含まれます。画像以外のファイルの場合はnullが入ります。

alt

メディアの管理画面から設定した代替テキストが含まれます。設定がない場合や画像以外のファイルの場合は、キー自体が含まれません。

セキュリティ

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

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

Webhookの詳細仕様

再送

Webhookの通知が、ネットワークエラーや4xx、5xxエラーにて失敗した場合でも、リトライ処理は行われません。

重複送信

Webhookの通知は、設定したタイミングにつき1回のみ行われます。

順序保証

原則として、Webhookの通知は操作の実行順に行われます。
ただし、厳密な制御は行われていないため、順序は保証されません。

送信元IPアドレス

Webhookの送信元IPアドレスは、動的IPアドレスです。
また、IPアドレスの範囲も公開しておりません。