Перейти к содержимому

События

GET
/api/v1/events
curl --request GET \
--url 'https://demo.goodwink.ru/api/v1/events?channel=webhook&limit=100' \
--header 'Authorization: Bearer <token>'

Лента сырых данных: каждое событие строкой, по порядку приёма транзакциями — событие транзакции, которая ещё не закончилась, лента не проскочит, а отдаст позже. Без cursor — с начала; удалённые — тоже, с deleted_at

source_id
integer

Только события этого источника

channel
string
Allowed values: webhook file pull

Только события этого канала

limit
integer
default: 100 >= 1 <= 1000

Сколько вернуть за запрос; вне 1–1000 — 400

cursor
string

Next_cursor прошлого ответа, как есть

Успех

Media typeapplication/json
object
data
required
Array<object>
object
id
required
integer
source
required
object
id
required
integer
name
required
string
channel
required

Адрес приёма, загрузка файла, опрос по адресу

string
Allowed values: webhook file pull
received_at
required

RFC 3339 в UTC, например 2026-10-19T13:30:00Z

string format: date-time
payload
required

Тело события, как разобрал приём: объект — поля события; тело, которое не разобралось, — служебными ключами _raw (текст), _value (JSON не объект), _parse_error (причина)

repeat_of
required

Повторная отправка: id первого события с тем же телом

integer | null
history
required

Из истории: загрузка файла и первый запуск опроса

boolean
deleted_at
required

Строку события удалили (корзина)

string | null format: date-time
has_more
required
boolean
next_cursor
required

Есть всегда: место, с которого продолжать — сразу, пока has_more, или в следующий раз

string | null

Example

{
"data": [
{
"channel": "webhook"
}
]
}
X-RateLimit-Limit
integer

Лимит запросов в минуту на ключ

X-RateLimit-Remaining
integer

Сколько осталось в этой минуте

Параметр не того вида, неизвестный (unknown_param) или выборка не применяется

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable
code
required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string
message
required

Что ждали — словами

string
param
required

Виноватый параметр

string | null

Example

{
"error": {
"type": "invalid_request"
}
}

Нет ключа, ключ неверный или отозван; WWW-Authenticate: Bearer

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable
code
required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string
message
required

Что ждали — словами

string
param
required

Виноватый параметр

string | null

Example

{
"error": {
"type": "invalid_request"
}
}

Нет такого источника или объекта

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable
code
required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string
message
required

Что ждали — словами

string
param
required

Виноватый параметр

string | null

Example

{
"error": {
"type": "invalid_request"
}
}

Превышен лимит запросов на ключ; Retry-After — через сколько секунд

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable
code
required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string
message
required

Что ждали — словами

string
param
required

Виноватый параметр

string | null

Example

{
"error": {
"type": "invalid_request"
}
}