microCMS

カスタム通知のボディ部にコンテンツ内容が含まれるようになりました

更新情報
松田 承一

こんにちは、松田です。
本日の更新情報をお知らせいたします。

カスタム通知がアップデートされました!

本日より、カスタム通知が行われた際のボディ部にコンテンツの詳細な内容が含まれるようになりました。

具体的には以下のような値がWebhookの通知時にボディ部に含まれます。
これまでは存在していなかったのはcontents部分です。

{
  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,
    },
  },
}

contentsには旧コンテンツと新コンテンツ、また下書き状態と公開状態それぞれのコンテンツ内容が含まれています。
内容の詳細はドキュメントをご参照ください。

これによってできるようになったこと

今回の修正により得られるメリットの一つとして通知の受け取り時にmicroCMSへのリクエストを行う必要がなくなったことがあげられます。
これまではコンテンツ内容(contents)はボディ部に含まれていなかったため、いくつかのケースでは通知で受け取った値を使って改めてmicroCMSのGET APIを呼び出す必要がありました。
今後はこういった処理は不要となりボディ部に含まれるデータをそのまま利用できるケースが出てくるかと思います。

また、受け取ったデータをそのままストレージに保存するだけで編集履歴のリアルタイムなバックアップなども可能でしょう。
※近い機能としてmicroCMSでは編集履歴管理監査ログをご提供しています。また、S3との柔軟な連携などもロードマップに含めております。

本日のお知らせは以上となります!
これまで以上に便利にお使いいただけるようになったカスタム通知で更なるシステム間連携を進めていただければ幸いです。

-----

microCMSは日々改善を進めています。
ご意見・ご要望は管理画面右下のチャット、公式Twitterお問い合わせからお気軽にご連絡ください!
引き続きmicroCMSをよろしくお願いいたします!

ABOUT ME

松田 承一
ウォンタ株式会社の代表 / 家族=👨‍👩‍👧 / ヤフー→大学教員など→現職 / 管理画面付きAPIがすぐに作れるmicroCMSというサービス作ってます。

microCMSとは

  1. 開発者、編集者どちらも分かりやすい管理画面

  2. 細かな権限管理や豊富な外部サービス・データ連携

  3. 安心の日本製・日本語でのチャットサポート