サービス連携 - NotePM APIドキュメント

概要

サービス連携APIを使用することで、NotePM 上で発生する各種イベントを対象のサービスで受け取ることが可能になります。
また、サービス連携APIを介した Webhook の追加/削除を使用することで、他のSaaSサービスやiPaaS 上でのワークフロー構築が容易になります。

サービス連携詳細

GET /api/v1/notes/:note_code/services HTTP/1.1

Copy

Request

パラメータなし

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}/services' \
-H 'Authorization: Bearer {アクセストークン}'

Copy

Response

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"
      }
    ]
}

Copy

サービス連携追加

POST /api/v1/notes/:note_code/services HTTP/1.1

Copy

Request

パラメータ	内容	必須
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"
}

Copy

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}/services' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "chat_work",
    "room_id": "123456",
    "api_token": "abcdefg"
}'

Copy

Response

HTTP/1.1 201 created
{
    "service": {
        "service_id": 4,
        "name": "webhook",
        "webhook_url": "https://hooks.com/AAAAAAAABBBBBBB"
    }
}

Copy

サービス連携削除

DELETE /api/v1/notes/:note_code/services/:service_id HTTP/1.1

Copy

Request

パラメータなし

cURLでのリクエスト例

curl -X DELETE 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}/services/{サービスID}' \
-H 'Authorization: Bearer {アクセストークン}'

Copy

Response

HTTP/1.1 204 No Content

Copy