概要

APIについて

Reactioの機能である「インシデント」と「一斉通知」のリソースを、外部ツールや独自プログラムによって作成および取得するための、RESTful APIです。
各機能のリソースには、HTTPメソッドのGETによる情報取得とPOSTでJSONデータの送信によって実行することができ、結果はJSON形式でレスポンスを受け取ります。
現時点では、作成と情報取得はできますが、編集と削除を行うことはできません。

APIリクエスト時に「X-Api-Key: <APIキー> 」をヘッダに付加し、プロジェクト管理画面で発行されたAPIキーと完全一致することで認証しております。

Webhookについて

Reactioの機能「インシデント」「タイムライントピック」「タイムラインメッセージ」「一斉通知」のリソースにおいてPCブラウザ画面、モバイルブラウザ画面、APIリクエストにて実行された内容を、外部URLにHTTPメソッドのPOSTでJSONデータを送信することができます。

JSONデータは、下記三つのフィールドとなります。
フィールド 説明
target どの対象に対してアクションを行ったかが記される string
action 対象に対してどのアクションを行ったかが記される string
data 対象に対してのアクションの結果が格納される object

外部URLで正常にリクエストが受信できない場合に、60秒でタイムアウトされ再送はされません。

Webhookでリクエストされる送信元IPは固定ではありません。
Webhookにて、指定されたURLへリクエストする際、プロジェクト管理画面で作成した発信元証明トークン「X-Reactio-Origin-Credential」がヘッダに付加されております。リクエストを受信される対象システムにて、発信元証明トークンの完全一致を検証することにより、送信元がReactioであることを認証することができます。

用語

リクエストURLの「 Organization_ID 」
組織ごとにランダムで割り当てられているURLのサブドメイン部

「 パラメータ 」
HTTPメソッドのPOSTで送信するJSONデータ内容

説明の カッコ 書き
(必須):パラメータとして必ず必要です。
(任意);指定しない場合は、空もしくはデフォルト内容になります。

パラメータの「 内容 」
(<文字列>):デフォルトの内容
自由形式:自由な文字列を入れられます。
選択形式;決められた文字を選択して入れます。
例)選択形式(open)
  ・open「発生中」
  ・pend「暫定対応」
  ・close「恒久対応」
数値形式:10進数の数値を入れます。
真理形式:true 又は falseを入れます。