POST /API/v2/Webhooks/Register

所属する会社にWebhook設定を登録します。 管理者が所属する会社に、Webhook設定を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。

Request Information

URI Parameters

None.

Body Parameters

v2.MyWebhook_Register

NameDescriptionTypeAdditional information
webhookName

Webhook設定の名称

String

Required

Max length: 150

companyId

会社ID

String

Required

Max length: 36

secretToken

シークレットトークン

String, Null

Max length: 2048

webhookUrl

Webhook Url

String

Required

Max length: 2048

Response Information

Resource Description

v2.MyWebhook

NameDescriptionTypeAdditional information
webhookId

Webhook設定ID

String

Required

Max length: 36

webhookName

Webhook設定の名称

String

Required

Max length: 150

companyId

会社ID

String

Required

Max length: 36

secretToken

シークレットトークン

String, Null

None.

webhookUrl

Webhook Url

String

Required

organizations

使用する組織

Collection, Null of organizations

None.

isNotifySetting

通知設定状況

Boolean

Required