Webhook

タスクの完了や失敗時にリアルタイムで通知を受け取ります

概要

Webhooks allow you to receive HTTP callbacks when your image or video generation tasks complete. Instead of polling for results, you can set up a webhook endpoint to receive automatic notifications.

利用可能なイベント

job.completedTriggered when a task completes successfully
job.failedTriggered when a task fails

APIエンドポイント

GET/api/v1/webhooks

List all your webhook configurations

レスポンス例:

{
  "success": true,
  "data": [
    {
      "id": 1,
      "url": "https://your-server.com/webhook",
      "events": ["job.completed", "job.failed"],
      "status": "active"
    }
  ]
}

POST/api/v1/webhooks

Create a new webhook endpoint

リクエストの例:

{
  "url": "https://your-server.com/webhook",
  "events": ["job.completed", "job.failed"],
  "secret_key": "your-secret-key"
}

パラメータ:

パラメータ	タイプ	必須	説明
url	string	必須	Your webhook endpoint URL
events	string[]	必須	Events to subscribe to
secret_key	string	オプション	Secret for signature verification

レスポンス例:

{
  "success": true,
  "data": {
    "id": 1,
    "url": "https://your-server.com/webhook",
    "events": ["job.completed", "job.failed"],
    "status": "active"
  }
}

DELETE/api/v1/webhooks/{id}

Delete a webhook endpoint

レスポンス例:

{
  "success": true,
  "data": { "id": 1 }
}

Webhookペイロード

Webhook通知のエンドポイント送信フォーマット

ヘッダー	説明
X-Nano-Timestamp	Unix timestamp of the request
X-Nano-Signature	HMAC-SHA256 signature for verification

サンプルペイロード:

{
  "event": "job.completed",
  "task_id": "task_xxx",
  "task_type": "image",
  "status": "completed",
  "data": {
    "url": "https://cdn.example.com/image.png",
    "credits_charged": 6
  },
  "timestamp": "2024-12-23T10:00:00Z"
}

署名検証

const crypto = require('crypto');

function verifySignature(payload, signature, secret, timestamp) {
  const message = `${timestamp}.${JSON.stringify(payload)}`;
  const expectedSig = crypto
    .createHmac('sha256', secret)
    .update(message)
    .digest('hex');
  return `v1=${expectedSig}` === signature;
}