サービス連携APIを使用することで、NotePM 上で発生する各種イベントを対象のサービスで受け取ることが可能になります。
また、サービス連携APIを介した Webhook の追加/削除を使用することで、他のSaaSサービスやiPaaS 上でのワークフロー構築が容易になります。
GET /api/v1/notes/:note_code/services HTTP/1.1
HTTP/1.1 200 OK
{
"services": [
{
"service_id": 1,
"name": "slack",
"webhook_url": "https://hooks.slack.com/services/AAAAAAAABBBBBBB"
},
{
"service_id": 2,
"name": "webhook",
"webhook_url": "https://hooks.com/AAAAAAAABBBBBBB"
},
{
"service_id": 3,
"name": "microsoft_teams",
"webhook_url": "https://outlook.office.com/webhook/AAAAAAAABBBBBBB"
}
]
}
POST /api/v1/notes/:note_code/services HTTP/1.1
| パラメータ | 内容 | 必須 | デフォルト値 | 最大値 |
|---|
| name | 連携するサービス名。連携できるサービスは下記
slack, chat_work, microsoft_teams, google_chat, webhook | ○ | | |
| webhook_url | hookするurl | nameがslack, microsoft_teams, google_chat, webhookの時に必須 | | |
| room_id | ルームID | nameがchatworkの時に必須 | | |
| api_token | APIトークン | nameがchatworkの時に必須 | | |
| secret | Secretトークン | nameがwebhookの時に任意 | | |
{
"name": "chat_work",
"room_id": "123456",
"api_token": "abcdefg"
}
HTTP/1.1 201 created
{
"service": {
"service_id": 4,
"name": "webhook",
"webhook_url": "https://hooks.com/AAAAAAAABBBBBBB"
}
}
DELETE /api/v1/notes/:note_code/services/:service_id HTTP/1.1
