カスタムAPI呼び出し

このピースでできること

  • Chatwork API(v2)に対して、任意のエンドポイントへカスタムリクエストを送信します。
 

Chatwork の接続方法

workrun と Chatwork を接続するには、Chatwork の OAuth クライアント(クライアントID ・ クライアントシークレット) が必要です。

ステップ 1:workrun のリダイレクト URL を確認する

  1. workrun で Chatwork のアクション/トリガーをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。

ステップ 2:Chatwork で OAuth クライアントを作成する

  1. OAuthクライアント作成画面 にアクセスします。
  1. 以下のように入力します:
      • クライアントタイプ: を選択
      • リダイレクト URI: ステップ 1 でコピーした URL を貼り付け
      • スコープ: 以下をすべてチェック
  1. 登録後、表示された クライアントIDクライアントシークレット をコピーします。

ステップ 3:workrun に接続を追加する

  1. ステップ 1 の接続画面に戻り、クライアントIDクライアントシークレット をそれぞれ貼り付けます。
  1. 「接続」 をクリックすると、Chatwork の認証画面が開きます。
  1. Chatwork にログインし、workrun に対するアクセスを 「許可」 します。
  1. 画面が自動で閉じ、接続が完了します。
 

ピースの設定項目

1. URL(必須)

  • 呼び出したいAPIのURLを指定します。
  • 完全なURL(例: )または、ベースURL()からの相対パス(例: )を指定できます。
[設定例]
/rooms

2. メソッド(必須)

  • HTTPメソッドを選択します(GET / POST / PUT / PATCH / DELETE / HEAD)。
[設定例]
GET

3. ヘッダー(任意)

  • 追加のリクエストヘッダーを指定します。
  • 認証ヘッダーは接続情報から自動で付与されるため、通常は追加不要です。
[設定例]
[{"key":"Content-Type","value":"application/json"}]

4. クエリパラメータ(任意)

  • URLのクエリパラメータを指定します。
[設定例]
[{"key":"force","value":"1"}]

5. ボディタイプ(任意)

  • リクエストボディの形式を選択します(JSON / Raw / フォームデータ / なし)。
[設定例]
JSON

6. ボディ(任意)

  • に応じた形式でリクエストボディを指定します。
  • たとえば の場合でも、API仕様によってはフォームエンコード文字列をそのまま渡す運用が可能です。
[設定例]
{"body":"テストメッセージ"}

7. 失敗時にエラーにしない(任意)

  • オンにすると、APIエラーが起きてもフロー全体を停止しません。
  • 通常はオフのままにし、必要な場合のみオンにしてください。
[設定例]
false