ナビゲーションにスキップ
BeatAPIWebhooksWebhooks

Webhooks

Create a webhook endpoint for optional BeatAPI task completion callbacks.

Store the signing secret returned at creation, verify every callback against the raw request body, and keep polling as the fallback source of truth. See the Quick Guide for production retry behavior.

認証

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

リクエスト

This endpoint expects an object.
urlstring必須形式: "uri"

Public HTTPS callback URL that accepts BeatAPI task events. Do not use localhost or a private-network URL.

descriptionstringオプション
Optional internal label for identifying the endpoint in your account.
eventslist of enumsオプション

Task events to deliver. Omit to subscribe to both task.succeeded and task.failed.

許可された値:

レスポンス

Webhook endpoint created
dataobject

Created or retrieved webhook endpoint. Public API responses return the full signing secret at creation and mask it afterward; authenticated dashboard owners can explicitly reveal it again.

エラー

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error