> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.beatapi.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server.

# Вебхуки

POST https://api.beatapi.io/v1/webhooks
Content-Type: application/json

Создайте обработчик вебхуков для необязательных уведомлений о завершении задач BeatAPI.

Сохраните секрет подписи, полученный при создании, проверяйте каждый обратный вызов по исходным байтам тела запроса и используйте опрос состояния как резервный достоверный источник. Правила повторов в рабочей среде приведены в [быстром старте](/quick-guide#errors-and-retry-policy).

Reference: https://docs.beatapi.io/api-reference/webhooks

## Authentication

- `Authorization` header (bearer token, required) — Передавайте API-ключ в виде `Authorization: Bearer <BEATAPI_API_KEY>`.

## Servers

- `https://api.beatapi.io` (Direct, default)
- `https://api.beatapi.io` (API)

## Request

### Body (application/json)

This endpoint expects an object.

- `url` (string, required) — Публичный HTTPS URL обратного вызова, принимающий события задач BeatAPI. Не используйте localhost или URL частной сети.
- `description` (string, optional) — Необязательная внутренняя метка для идентификации обработчика в аккаунте.
- `events` (list of enum, optional) — События задач для доставки. Если не указано, подписка включает `task.succeeded` и `task.failed`.
  - Allowed values: `task.succeeded`, `task.failed`

## Response

### 201

Обработчик вебхуков создан

- `data` (WebhookEndpoint, required) — Созданный или полученный обработчик вебхуков. Публичный API возвращает полный секрет подписи при создании и маскирует его в дальнейшем; авторизованный владелец аккаунта в панели управления может явно запросить его повторный показ.

## Errors

### 400 Bad Request Error

Некорректный JSON либо недопустимое поле, значение или сочетание для этого эндпоинта (`bad_request`; сообщение называет поле), либо отклонение модерацией (`content_policy_violation`). Повтор без изменений не допускается.

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 401 Unauthorized Error

Нет API-ключа (`missing_api_key`) либо ключ неверен, истёк, отключён или исчерпан (`invalid_api_key`; причина указана в сообщении). Передайте его как `Authorization: Bearer <key>`; ключ работает как с префиксом `sk-`, так и без него. Повтор не допускается.

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 429 Too Many Requests Error

Слишком много запросов (`rate_limit_exceeded`, включая ограничения бесплатных моделей). Повтор допустим через количество секунд из `Retry-After` (также `error.retry_after_seconds`).

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 500 Internal Server Error

Непредвиденная внутренняя ошибка (`internal_error`). Повтор допустим; сохраните `request_id` для поддержки, если ошибка повторяется.

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

## Types

### WebhookEndpoint

- `id` (string, required) — Стабильный идентификатор обработчика вебхуков для получения, изменения и удаления.
- `object` (enum, required) — Дискриминатор объекта; всегда `webhook_endpoint`.
  - Allowed values: `webhook_endpoint`
- `url` (string, required) — Публичный HTTPS URL обратного вызова, принимающий события задач по подписке.
- `description` (string, required) — Метка обработчика, заданная владельцем аккаунта.
- `events` (list of enum, required) — Типы событий задач, доставляемые этому обработчику.
  - Allowed values: `task.succeeded`, `task.failed`
- `status` (enum, required) — Состояние доставки. Отключённые обработчики не получают события.
  - Allowed values: `active`, `disabled`
- `secret` (string, required) — Возвращается полностью только при создании обработчика. В последующих ответах значение маскируется.
- `created_at` (integer, required) — Unix-время создания обработчика.
- `updated_at` (integer, required) — Unix-время последнего изменения обработчика.

### ErrorError

Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

- `code` (enum, required) — Стабильный машиночитаемый код ошибки. `unauthorized` — прежнее название ошибки 401; с 2026-09-29 при 401 возвращается `missing_api_key` или `invalid_api_key`, но `unauthorized` ещё может встречаться. Обрабатывайте его как `invalid_api_key`. `result_expired` возвращается только `POST /v1/capabilities/run` с `operation: "result"`.
  - Allowed values: `bad_request`, `missing_api_key`, `invalid_api_key`, `unauthorized`, `forbidden`, `not_found`, `insufficient_credits`, `idempotency_conflict`, `rate_limit_exceeded`, `content_policy_violation`, `processing_unavailable`, `processing_failed`, `processing_timeout`, `result_transfer_failed`, `result_expired`, `not_implemented`, `realtime_disabled`, `realtime_capacity_unavailable`, `realtime_session_expired`, `origin_not_allowed`, `invalid_client_secret`, `transport_not_allowed`, `internal_error`
- `message` (string, required) — Предложение на английском с причиной ошибки; для `bad_request` указывает поле. Предназначено для людей и журналов, а не для программного разбора.
- `request_id` (string, required) — Идентификатор корреляции, который нужно сохранить для поддержки BeatAPI.
- `retryable` (boolean, optional) — Может ли повтор того же вызова завершиться успешно. Присутствует для каждого кода публичной таблицы; может отсутствовать только для кода вне неё. True для rate_limit_exceeded, internal_error, processing_unavailable, processing_timeout, processing_failed, result_transfer_failed и realtime_capacity_unavailable. False, если сначала нужно изменить запрос, ключ или баланс (bad_request, content_policy_violation, missing_api_key, invalid_api_key, unauthorized, insufficient_credits, forbidden, not_found, idempotency_conflict, result_expired, not_implemented, realtime_disabled и остальные коды учётных данных realtime).
- `retry_after_seconds` (integer, optional) — Задержка перед повтором в секундах. Передаётся только при 429 `rate_limit_exceeded`; то же значение содержится в заголовке `Retry-After`. У других кодов отсутствует.
- `docs` (string, optional) — Публичная страница Skill с инструкциями по устранению ошибки. Присутствует в ошибках эндпоинтов возможностей (`/v1/capabilities/search`, `/v1/capabilities/inspect`, `/v1/capabilities/run`); у всех остальных отсутствует.

## Examples

**Request**

```json
{
  "url": "https://example.com/beatapi-webhook",
  "events": [
    "task.succeeded",
    "task.failed"
  ]
}
```

**Response**

```json
{
  "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_store_this_once",
    "created_at": 1782210000,
    "updated_at": 1782210000
  }
}
```

**SDK Code**

```python Webhooks
import requests

url = "https://api.beatapi.io/v1/webhooks"

payload = {
    "url": "https://example.com/beatapi-webhook",
    "events": ["task.succeeded", "task.failed"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Webhooks
const url = 'https://api.beatapi.io/v1/webhooks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"url":"https://example.com/beatapi-webhook","events":["task.succeeded","task.failed"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Webhooks
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beatapi.io/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/beatapi-webhook\",\n  \"events\": [\n    \"task.succeeded\",\n    \"task.failed\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Webhooks
require 'uri'
require 'net/http'

url = URI("https://api.beatapi.io/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/beatapi-webhook\",\n  \"events\": [\n    \"task.succeeded\",\n    \"task.failed\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Webhooks
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.beatapi.io/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/beatapi-webhook\",\n  \"events\": [\n    \"task.succeeded\",\n    \"task.failed\"\n  ]\n}")
  .asString();
```

```php Webhooks
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beatapi.io/v1/webhooks', [
  'body' => '{
  "url": "https://example.com/beatapi-webhook",
  "events": [
    "task.succeeded",
    "task.failed"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Webhooks
using RestSharp;

var client = new RestClient("https://api.beatapi.io/v1/webhooks");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://example.com/beatapi-webhook\",\n  \"events\": [\n    \"task.succeeded\",\n    \"task.failed\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Webhooks
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "url": "https://example.com/beatapi-webhook",
  "events": ["task.succeeded", "task.failed"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beatapi.io/v1/webhooks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```