Update a webhook endpoint

PATCH

/v1/webhooks/{id}

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Webhook endpoint updated

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.beatapi.io/v1/webhooks/wh_9aBcD' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "status": "disabled"
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "wh_9aBcD",
        "object": "webhook_endpoint",
        "url": "https://example.com/beatapi-webhook",
        "events": [
            "task.succeeded"
        ],
        "status": "active",
        "secret": "whsec_example_masked",
        "created_at": 0
    }
}

Modified at 2026-06-25 13:50:22

Get a webhook endpoint

Delete a webhook endpoint