Update a webhook endpoint

PATCH

https://api.beatapi.io/v1/webhooks/:id

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

urlstringOptionalformat: "uri"

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

descriptionstringOptional

statusenumOptional

Allowed values:

eventslist of enumsOptional

Allowed values:

Response

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.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -X PATCH https://api.beatapi.io/v1/webhooks/wh_9aBcD \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"status": "disabled"
>	}'

1	{
2	"data": {
3	"id": "wh_9aBcD",
4	"object": "webhook_endpoint",
5	"url": "https://example.com/beatapi-webhook",
6	"description": "Production webhook",
7	"events": [
8	"task.succeeded"
9	],
10	"status": "active",
11	"secret": "whsec_example_masked",
12	"created_at": 1,
13	"updated_at": 1
14	}
15	}