Incoming Webhook

Incoming Webhookのよく使うpayload設定まとめ

たまに触ると忘れているのでメモ…

設定系

ポストごとに送信するチャンネルを変える

{
    "channel": "#new_channel",
    "text": "テストだよ"
}

ポストごとにbotの表示名を変える

{
    "username": "Webhookマン",
    "text": "テストだよ"
}

ポストごとにbotのアイコンを変える

{
    "icon_emoji": ":bow:",
    "text": "テストだよ"
}

channelで投稿先を指定していると、チャンネルを削除した時にエラーになるので、あまり使わない方がよさそう

メンション系

ユーザーにメンションを送る

ユーザーにメンションを送る場合は@で指定するが、「ユーザー名」ではなく「メンバーID」を使用する。

{
    "text": "good night <@U01231WAS8J>"
}

@hereや@channel指定をする場合

hereやchannel指定をする場合は@ではなく!を使用する。

{
    "text": "come on <!here> <!channel>"
}

テキストの装飾について

以前使った時と仕様が変わっていたのでメモ…

細かいカスタマイズができたattachmentsについてはlegacyとして非推奨になり、代わりにblocksを使えとのこと。

An array of legacy secondary attachments. We recommend you use blocks instead.

blocksを使用した装飾についてはBlock Kit Builderという画面上でjsonを確認できるモックページが用意されているので、少し触れば使える機能は大体わかる。

ちなみにblocksではcolorが使えないので、color使いたい場合はattachmentsを併用して使うしかないみたい

There is one exception, and that's the color parameter, which currently does not have a block alternative. If you are strongly attached (🎺) to the color bar, use the blocks parameter within an attachment.

ABOUT ME
ytakeuchi
都内在住のフロントエンドエンジニア。2016年からフリーランスとして活動中。座右の銘は「昨日よりも楽に」。好きな言葉は「効率化」。こんな性格なのでプライベートではGoogle Apps Scriptばかり触っています。