API

Вебхуктарға жазылулар тізімін алу

GET/api/crm/v2/webhooks_subscriptionsv2
operationId: webhooksSubscriptions.default

Авторизация

api-token + language + role

Сұраныс параметрлері

branch_idinteger

Мысал: 8412

Жауаптар

OK

object
statusstringміндетті

Мәндер:successerror

Мысал: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

settingsobject (WebhooksBranchSettings)
secretstringnull мәнін қабылдай алады

null, желі құпиясөзді құрмағанша

Мысал: 9f2c…

enabledbooleanміндетті

Мысал: true

listarray of object
idintegerміндетті

Мысал: 12

date_creationstring (DataTimeFormatSQL) міндетті

Мысал: 2024-05-02 08:31:16

webhook_event_idintegerміндетті

Мысал: 4

slugstringміндетті

Вебхук денесінде жіберілетін оқиға коды

Мысал: order.created

translation_keystringміндетті

Оқиға атауының аударма кілті

Мысал: webhooksSubscriptionsEvent.orderCreated

urlstringміндетті

Мысал: https://partner.example.com/hooks/foodsoul

descriptionstringміндетті

Мысал: Учётная система

enabledbooleanміндетті

Мысал: true

blockedbooleanміндетті

Жазылу бірнеше қате орын алғаннан кейін автоматты түрде өшіріледі

Мысал: false

count_errorsintegerміндетті

Қатарынан сәтсіз жіберулер саны

Мысал: 0