通知先の更新

Prev Next
Patch
/api/notification_destinations/{type}/{notification_destination_id}

指定した通知先の情報を更新します。

Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。

Path parameters
type
stringRequired

通知先種別(email、slack_channel または http)

Valid values[ "email", "slack_channel", "http" ]
Exampleemail
notification_destination_id
integer (int64) Required

通知先(email、slack_channel または http)のIDです。

Example1
Body parameters
Expand All
OneOf
object
object
email_config
object Required
email
string Required

更新するメールアドレス。

Exampleupdate@example.com
object
object
slack_channel_config
object Required
channel
string Required

更新するslack_channelチャンネル名。

Example#updated
webhook_url
string Required

更新するslack_channelのWebhook URL。

Examplehttps://hooks.slack_channel.com/services/XXXX/XXXX/XXXX
object
object
http_config
object Required

HTTP通知先の更新設定です。
headers / query_params を省略した場合は既存の値が維持されます。
headers / query_params を指定した場合は洗い替え(送信されていない既存要素は削除)されます。
既存要素を更新する場合は id を指定してください。
masking=true かつ value が空文字の場合、既存の value が保持されます。

name
string Required

更新する通知先の名前。

ExampleMy Webhook
url
string Required

更新するリクエスト先のURL。TROCCOのドメインは指定できません。

Examplehttps://example.com/webhook
description
string

更新する通知先の説明。

ExampleSlack Incoming Webhook
headers
Array of object

更新するリクエストヘッダーの一覧。

object
id
integer (int64)

既存ヘッダーを更新する場合に指定するIDです。

Example1
key
string Required
ExampleAuthorization
value
string Required

masking=true かつ空文字の場合は既存値が保持されます。

ExampleBearer xxxx
masking
boolean Required

value をレスポンスでマスキングするかどうか。

Exampletrue
query_params
Array of object

更新するクエリパラメータの一覧。

object
id
integer (int64)

既存クエリパラメータを更新する場合に指定するIDです。

Example1
key
string Required
Exampletoken
value
string Required

masking=true かつ空文字の場合は既存値が保持されます。

Examplexxxx
masking
boolean Required

value をレスポンスでマスキングするかどうか。

Exampletrue
Responses
200

更新後の通知先情報を返します。

Expand All
object
Example{ "id": 1, "type": "email", "email": "test@example.com" }
id
integer (int64)

通知先のIDです。

type
string

通知先の種類です。

Valid values[ "email", "slack_channel", "http" ]
Exampleemail
email
string

type=email の場合に設定されるメールアドレスです。

Exampletest@example.com
channel
string | null

type=slack_channel の場合に設定されるチャンネル名です。

Example#general
name
string

type=http の場合に設定される通知先の名前です。

ExampleMy Webhook
url
string

type=http の場合に設定されるリクエスト先のURLです。

Examplehttps://example.com/webhook
description
string | null

type=http の場合に設定される通知先の説明です。

ExampleSlack Incoming Webhook
headers
Array of object

type=http の場合に設定されるリクエストヘッダーの一覧です(id 昇順)。
masking=true のヘッダーの value は空文字で返却されます。

object
id
integer (int64)

ヘッダーのIDです。

key
string

ヘッダー名です。

ExampleAuthorization
value
string

ヘッダーの値です。masking=true の場合は空文字が返却されます。

ExampleBearer xxxx
masking
boolean

value をレスポンスでマスキングするかどうかです。

Exampletrue
query_params
Array of object

type=http の場合に設定されるクエリパラメータの一覧です(id 昇順)。
masking=true のクエリパラメータの value は空文字で返却されます。

object
id
integer (int64)

クエリパラメータのIDです。

key
string

クエリパラメータ名です。

Exampletoken
value
string

クエリパラメータの値です。masking=true の場合は空文字が返却されます。

Examplexxxx
masking
boolean

value をレスポンスでマスキングするかどうかです。

Exampletrue
400

不正なリクエストです。

401

認証エラーです。API KEYをご確認ください。

404

指定した通知先が存在しません。