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)
secretstringშეიძლება იყოს null

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