Перейти к содержанию

Вебхуки

Эндпоинты вебхуков Slicer API — добавить адрес и получить секрет подписи, изменить, удалить, отправить проверочное событие и посмотреть журнал доставок.

На этой странице

Вебхуки сообщают вашему серверу о событиях: готова загрузка, закончился монтаж или экспорт, опубликован ролик. Нужна область webhooks. Формат событий, подпись и её проверка — в руководстве Вебхуки.

Добавить вебхук

POST/v1/webhooks
Области доступа
webhooks
Лимит
обычный

Тело запроса CreateWebhookRequest

Поле Тип Описание
urlобязательноеstring (uri)≤ 2048
eventsобязательноеstring[]
descriptionstring≤ 200

Запрос

curl
JavaScript
Python
curl -X POST "https://api.slicer.media/v1/webhooks" \
  -H "Authorization: Bearer $SLICER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hook","events":["upload.ready"]}'

Ответ

Поля ответа: CreatedWebhook (2)
Поле Тип Описание
webhookобязательноеWebhook
secretобязательноеstringСекрет подписи whsec_… — показывается один раз
Пример ответа
{
  "ok": true,
  "data": {
    "webhook": {
      "id": "6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20",
      "url": "https://example.com/hook",
      "events": [
        "upload.ready"
      ],
      "description": "string",
      "enabled": true,
      "disabledReason": "string",
      "failures": 1,
      "lastDeliveryAt": "2026-10-16T09:30:00Z",
      "createdAt": "2026-10-16T09:30:00Z"
    },
    "secret": "whsec_…"
  }
}

Список вебхуков

GET/v1/webhooks
Области доступа
webhooks
Лимит
обычный

Запрос

curl
JavaScript
Python
curl "https://api.slicer.media/v1/webhooks" \
  -H "Authorization: Bearer $SLICER_TOKEN"

Ответ

Пример ответа
{
  "ok": true,
  "data": [
    {
      "id": "6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20",
      "url": "https://example.com/hook",
      "events": [
        "upload.ready"
      ],
      "description": "string",
      "enabled": true,
      "disabledReason": "string",
      "failures": 1,
      "lastDeliveryAt": "2026-10-16T09:30:00Z",
      "createdAt": "2026-10-16T09:30:00Z"
    }
  ]
}

Вебхук

GET/v1/webhooks/{id}
Области доступа
webhooks
Лимит
обычный

Параметры пути

Поле Тип Описание
idобязательноеstring (uuid)

Запрос

curl
JavaScript
Python
curl "https://api.slicer.media/v1/webhooks/6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20" \
  -H "Authorization: Bearer $SLICER_TOKEN"

Ответ

Поля ответа: Webhook (9)
Поле Тип Описание
idобязательноеstring (uuid)
urlобязательноеstring (uri)
eventsобязательноеstring[]
descriptionобязательноеstring | null
enabledобязательноеboolean
disabledReasonобязательноеstring | null
failuresобязательноеintegerНеудачных доставок подряд
lastDeliveryAtобязательноеstring | null
createdAtобязательноеstringДата и время ISO 8601, UTC
Пример ответа
{
  "ok": true,
  "data": {
    "id": "6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20",
    "url": "https://example.com/hook",
    "events": [
      "upload.ready"
    ],
    "description": "string",
    "enabled": true,
    "disabledReason": "string",
    "failures": 1,
    "lastDeliveryAt": "2026-10-16T09:30:00Z",
    "createdAt": "2026-10-16T09:30:00Z"
  }
}

Изменить вебхук

PATCH/v1/webhooks/{id}
Области доступа
webhooks
Лимит
обычный

Параметры пути

Поле Тип Описание
idобязательноеstring (uuid)

Тело запроса UpdateWebhookRequest

Поле Тип Описание
urlstring (uri)≤ 2048
eventsstring[]
descriptionstring | null≤ 200
enabledboolean

Запрос

curl
JavaScript
Python
curl -X PATCH "https://api.slicer.media/v1/webhooks/6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20" \
  -H "Authorization: Bearer $SLICER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hook","events":["upload.ready"]}'

Ответ

Поля ответа: Webhook (9)
Поле Тип Описание
idобязательноеstring (uuid)
urlобязательноеstring (uri)
eventsобязательноеstring[]
descriptionобязательноеstring | null
enabledобязательноеboolean
disabledReasonобязательноеstring | null
failuresобязательноеintegerНеудачных доставок подряд
lastDeliveryAtобязательноеstring | null
createdAtобязательноеstringДата и время ISO 8601, UTC
Пример ответа
{
  "ok": true,
  "data": {
    "id": "6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20",
    "url": "https://example.com/hook",
    "events": [
      "upload.ready"
    ],
    "description": "string",
    "enabled": true,
    "disabledReason": "string",
    "failures": 1,
    "lastDeliveryAt": "2026-10-16T09:30:00Z",
    "createdAt": "2026-10-16T09:30:00Z"
  }
}

Удалить вебхук

DELETE/v1/webhooks/{id}
Области доступа
webhooks
Лимит
обычный

Параметры пути

Поле Тип Описание
idобязательноеstring (uuid)

Запрос

curl
JavaScript
Python
curl -X DELETE "https://api.slicer.media/v1/webhooks/6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20" \
  -H "Authorization: Bearer $SLICER_TOKEN"

Ответ

Поля ответа: object (2)
Поле Тип Описание
idобязательноеstring (uuid)
deletedобязательноеboolean
Пример ответа
{
  "ok": true,
  "data": {
    "id": "6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20",
    "deleted": true
  }
}

Отправить проверочное событие `ping`

POST/v1/webhooks/{id}/test
Области доступа
webhooks
Лимит
обычный

Параметры пути

Поле Тип Описание
idобязательноеstring (uuid)

Запрос

curl
JavaScript
Python
curl -X POST "https://api.slicer.media/v1/webhooks/6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20/test" \
  -H "Authorization: Bearer $SLICER_TOKEN"

Ответ

Поля ответа: WebhookDelivery (9)
Поле Тип Описание
idобязательноеinteger
eventIdобязательноеstring
typeобязательноеstring
statusобязательноеstringpending · succeeded · failed
attemptsобязательноеinteger
responseStatusобязательноеinteger | null
errorобязательноеstring | null
createdAtобязательноеstringДата и время ISO 8601, UTC
deliveredAtобязательноеstring | null
Пример ответа
{
  "ok": true,
  "data": {
    "id": 42,
    "eventId": "string",
    "type": "string",
    "status": "pending",
    "attempts": 1,
    "responseStatus": 1,
    "error": "string",
    "createdAt": "2026-10-16T09:30:00Z",
    "deliveredAt": "2026-10-16T09:30:00Z"
  }
}

Последние 100 доставок

GET/v1/webhooks/{id}/deliveries
Области доступа
webhooks
Лимит
обычный

Параметры пути

Поле Тип Описание
idобязательноеstring (uuid)

Запрос

curl
JavaScript
Python
curl "https://api.slicer.media/v1/webhooks/6f1c2a4e-8b3d-4c1a-9e2f-3b5d7a9c1e20/deliveries" \
  -H "Authorization: Bearer $SLICER_TOKEN"

Ответ

Пример ответа
{
  "ok": true,
  "data": [
    {
      "id": 42,
      "eventId": "string",
      "type": "string",
      "status": "pending",
      "attempts": 1,
      "responseStatus": 1,
      "error": "string",
      "createdAt": "2026-10-16T09:30:00Z",
      "deliveredAt": "2026-10-16T09:30:00Z"
    }
  ]
}

Схемы

Webhook

Поле Тип Описание
idобязательноеstring (uuid)
urlобязательноеstring (uri)
eventsобязательноеstring[]
descriptionобязательноеstring | null
enabledобязательноеboolean
disabledReasonобязательноеstring | null
failuresобязательноеintegerНеудачных доставок подряд
lastDeliveryAtобязательноеstring | null
createdAtобязательноеstringДата и время ISO 8601, UTC

CreatedWebhook

Поле Тип Описание
webhookобязательноеWebhook
secretобязательноеstringСекрет подписи whsec_… — показывается один раз

WebhookDelivery

Поле Тип Описание
idобязательноеinteger
eventIdобязательноеstring
typeобязательноеstring
statusобязательноеstringpending · succeeded · failed
attemptsобязательноеinteger
responseStatusобязательноеinteger | null
errorобязательноеstring | null
createdAtобязательноеstringДата и время ISO 8601, UTC
deliveredAtобязательноеstring | null