Get a webhook endpoint

GET

/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

Responses

🟢200

application/json

Webhook endpoint

Bodyapplication/json

🟠404

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.beatapi.io/v1/webhooks/wh_9aBcD' \
--header 'Authorization: Bearer <token>'

Response Example

200 - 成功示例

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

Modified at 2026-07-31 15:10:04

Create a webhook endpoint

Update a webhook endpoint