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

Update a webhook endpoint

認証

AuthorizationBearer

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

パスパラメータ

idstring必須

リクエスト

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オプション
statusenumオプション
許可された値:
eventslist of enumsオプション
許可された値:

レスポンス

Webhook endpoint updated
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
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error