Webhookを登録する

在庫が変わったときに通知するURLを登録します。通知に在庫の中身は載せないので、受け取ったら /inventory/changes を読んでください。呼ぶたびに新しい署名用シークレットが返ります。URLはhttpsで、戻り先URLのどれかと同じオリジンにします。

通知は POST url で、本文は {"type":"inventory.changed","tenantId","connectionId","occurredAt"} です。X-TorecaCloud-Signature: v1=<hex> は、シークレット文字列をキーにした HMAC-SHA256("<X-TorecaCloud-Timestamp>.<本文>") です。時刻が300秒以上ずれた通知は拒否してください。

PUT/webhook

Authorization

AuthorizationOAuth2 access token · headerrequired

認可コードフロー（PKCE S256 必須）。認可・トークン・更新のリクエストには resource=https://api.toreca-cloud.com/partner/v1 を付けます。アクセストークンは15分、リフレッシュトークンは90日有効で、更新のたびに入れ替わります。

Scopes:inventory:read

Request body

requiredapplication/json

urlstring<uri>required

Responses

200

登録しました

urlstring<uri>required

secretstringrequired

署名用シークレット（whsec_ で始まる）。この応答でしか返りません。

createdAtstring<date-time>required

422

invalid_webhook_url

errorstringrequired

エラーのコード

scopestring

insufficient_scope のとき、足りない権限

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

urlstring*

Request

curl -X PUT 'https://api.toreca-cloud.com/partner/v1/webhook' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com"
}'

const response: Response = await fetch("https://api.toreca-cloud.com/partner/v1/webhook", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"url\": \"http://example.com\"\n}"
});

import requests

response = requests.put(
    "https://api.toreca-cloud.com/partner/v1/webhook",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"url\": \"http://example.com\"\n}",
)

Response

{
  "url": "http://example.com",
  "secret": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "error": "string",
  "scope": "string"
}