{
  "event_type": "microcms_build",
  "client_payload": {
    "service": "your_service",
    "api": "news",
    "id": "RX252Zoo7",
    "draftKey": "2Jnt22mLh5",
    "type": "new"
  }
}

event_type

event_typeには、トリガーイベント名に指定した値が含まれます。

この値はGitHub Actions内で github.event.actionとして参照できます。

client_payload

client_payloadには対象となったコンテンツやAPIの情報が含まれます。

{
    "service": "your_service",
    "api": "news",
    "id": "RX252Zoo7",
    "draftKey": "2Jnt22mLh5",
    "type": "new"
}

項目	説明
`service`	変更のあったコンテンツが属するサービスのサブドメインが入ります。
`api`	APIの更新時・削除時に指定したエンドポイントが入ります。
`id`	コンテンツのidが入ります。コンテンツに関する操作が行われた場合のみ含まれます。
`draftKey`	管理画面で取得できる下書きキー（`draftKey`）が入ります。コンテンツが下書き、もしくは予約公開状態の場合にのみ含まれます。
`type`	変更の種類です。新規追加時は`new`、編集時は`edit`、削除時は`delete`が入ります。（コンテンツの公開ステータスの変更とは関係なく、データに対する変更の種類となります。）

これらの値はGitHub Actions内でgithub.event.client_payloadとして参照できます。

メール通知

コンテンツやAPIの変更時などに指定したメールアドレスに変更内容を送信できます。
送信元メールアドレスはinfo@microcms.ioです。
設定内容は下記の通りです。

メールアドレス

また、SlackやChatworkのWebhookと同様に、本文内にはURLが含まれますがこちらも任意のものに変更可能です。

カスタム通知

任意のURLに対してPOSTリクエストを送信します。
設定内容は下記の通りです。

POST先となるURL

カスタム通知について

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

microCMSにはWebhookリクエストがmicroCMSからのものであることを検証するためのヘッダ値を付与できます。
付与にあたってはシークレット値を設定する必要があり、microCMSでは設定することを推奨いたします。

シークレット値が設定されている場合のみ、リクエストのヘッダにx-microcms-signature: <COMPUTED_HASH>が付与されます。
※ペイロードはmicroCMSがシークレット値とリクエストボディからSHA-256を使用したハッシュベースのHMACで生成します。

シークレット値はカスタム通知の設定画面で変更できます。
シークレット値には極力推測されづらい値を設定してください。（例： ruby -rsecurerandom -e 'puts SecureRandom.hex(20)' で生成した値）

Signatureの検証

以下2つの値を比較することで検証を行うことができ、リクエストがmicroCMSからのものであることを検証可能です。

x-microcms-signatureヘッダで受け取った値
ペイロード（request.body ）と設定したシークレット値を元にした値

一例としてNode.jsの場合、検証は以下のような実装で行うことができます。

const crypto = require('crypto');

const expectedSignature = crypto
  .createHmac('sha256', <設定したシークレット>)
  .update(request.body)
  .digest('hex');

const signature = request.headers['x-microcms-signature'];

if (typeof signature !== 'string') {
  throw new Error('Invalid signature.');
}

const signatureBuffer = Buffer.from(signature);
const expectedSignatureBuffer = Buffer.from(expectedSignature);

if (
  signatureBuffer.length !== expectedSignatureBuffer.length ||
  !crypto.timingSafeEqual(signatureBuffer, expectedSignatureBuffer)
) {
  throw new Error('Invalid signature.');
}

リクエスト内容

ヘッダ

リクエストヘッダには Content-Type: application/json が含まれます。
また、上述のシークレットを設定済みの場合は x-microcms-signature: <SIGNATURE_VALUE> が含まれます。

任意のリクエストヘッダーを追加することも可能です。カスタムリクエストヘッダー の「+」ボタンをクリックして追加してください。

Information: セキュリティの観点から、microCMSのドメイン（.microcms.io, .microcms-management.io）宛てにWebhookを設定することを制限しています。

ボディ

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

{
  service: 'webhook-test',
  api: 'news',
  id: 'x2xkcwog9521',
  type: 'edit',
  contents: {
    old: {
      id: 'x2xkcwog9521',
      status: ['DRAFT'],
      draftKey: 'Vyf_XTclTY',
      publishValue: null,
      draftValue: {
        id: 'x2xkcwog9521',
        createdAt: '2021-06-02T05:56:24.513Z',
        updatedAt: '2021-06-02T06:05:09.601Z',
        publishedAt: '2021-06-02T06:05:09.601Z',
        revisedAt: '2021-06-02T06:05:09.601Z',
        title: 'タイトルです',
      },
    },
    new: {
      id: 'x2xkcwog9521',
      status: ['PUBLISH'],
      draftKey: null,
      publishValue: {
        id: 'x2xkcwog9521',
        createdAt: '2021-06-02T05:56:24.513Z',
        updatedAt: '2021-06-02T06:05:09.601Z',
        publishedAt: '2021-06-02T06:05:09.601Z',
        revisedAt: '2021-06-02T06:05:09.601Z',
        title: 'タイトルです',
      },
      draftValue: null,
    },
  },
}

項目	説明
`service`	変更のあったコンテンツが属するサービスのサブドメインが入ります。
`api`	API作成時・更新時に指定したエンドポイントが入ります。
`id`	コンテンツのidが入ります。APIに関する操作の場合は`null`が入ります。
`type`	変更の種類です。新規追加時は`new`、編集時は`edit`、削除時は`delete`が入ります。（コンテンツの公開ステータスの変更とは関係なく、データに対する変更の種類となります。）
`contents`	コンテンツ内容が入ります。APIに関する操作の場合は`null`が入ります。
`contents.old`	コンテンツの編集前もしくは削除前の内容が含まれます。コンテンツの新規作成時には`null`が入ります。
`contents.old.id`	コンテンツの編集前もしくは削除前のコンテンツの`id`が含まれます。
`contents.old.status`	コンテンツの公開状態を配列で示します。公開中は`PUBLISH`、下書き中は`DRAFT`、公開終了は`CLOSED`が含まれます。
`contents.old.draftKey`	コンテンツが下書き状態が含まれる場合に、管理画面で取得できる下書きキー（draftKey）が入ります。公開状態のみの場合は`null`が入ります。
`contents.old.publishValue`	公開状態のコンテンツをGET APIで取得した際のjsonデータが含まれます。
`contents.old.draftValue`	下書き状態のコンテンツをGET APIで取得した際のjsonデータが含まれます。
`contents.new`	コンテンツの作成後もしくは編集後の内容が含まれます。コンテンツの削除時には`null`が入ります。
`contents.new.id`	コンテンツの作成後もしくは編集後のコンテンツの`id`が含まれます。
`contents.new.status`	コンテンツの公開状態を配列で示します。公開中は`PUBLISH`、下書き中は`DRAFT`、公開終了は`CLOSED`が含まれます。
`contents.new.draftKey`	コンテンツが下書き状態が含まれる場合に、管理画面で取得できる下書きキー（draftKey）が入ります。公開状態のみの場合は`null`が入ります。
`contents.new.publishValue`	公開状態のコンテンツをGET APIで取得した際のjsonデータが含まれます。
`contents.new.draftValue`	下書き状態のコンテンツをGET APIで取得した際のjsonデータが含まれます。