ვებჰუკის გამოწერის შექმნა

POST/api/crm/v2/webhooks_subscriptions.addv2

operationId: webhooksSubscriptions.add

ავტორიზაცია

api-token + language + role

მოთხოვნის პარამეტრები

branch_idintegerსავალდებულო

მაგალითი: 8412

მოთხოვნის სხეული `application/json`

object

webhook_event_idintegerსავალდებულო

მაგალითი: 4

urlstringსავალდებულო

მაგალითი: https://partner.example.com/hooks/foodsoul

descriptionstringსავალდებულო

მაგალითი: Учётная система

პასუხები

object

statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataobject

rowobject

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

curl -X POST 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412' \ -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \ -H 'language: ka' \ -H 'role: partner' \ -H 'Content-Type: application/json' \ -d '{"webhook_event_id":4,"url":"https://partner.example.com/hooks/foodsoul","description":"Учётная система"}'

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ka', 'role' => 'partner', ], 'json' => [ 'webhook_event_id' => 4, 'url' => 'https://partner.example.com/hooks/foodsoul', 'description' => 'Учётная система', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412", { method: "POST", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ka", "role": "partner", "Content-Type": "application/json" }, body: JSON.stringify({ "webhook_event_id": 4, "url": "https://partner.example.com/hooks/foodsoul", "description": "Учётная система" }), }) const data = await response.json()

import requests response = requests.request( "POST", "https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ka", "role": "partner", }, json={ "webhook_event_id": 4, "url": "https://partner.example.com/hooks/foodsoul", "description": "Учётная система", }, ) data = response.json()

{ "status": "success", "data": { "row": { "settings": { "secret": "9f2c…", "enabled": true }, "list": [ { "id": 12, "date_creation": "2024-05-02 08:31:16", "webhook_event_id": 4, "slug": "order.created", "translation_key": "webhooksSubscriptionsEvent.orderCreated", "url": "https://partner.example.com/hooks/foodsoul", "description": "Учётная система", "enabled": true, "blocked": false, "count_errors": 0 } ] } } }

ვებჰუკის გამოწერის შექმნა

ავტორიზაცია

მოთხოვნის პარამეტრები

მოთხოვნის სხეული application/json

პასუხები

მოთხოვნის სხეული `application/json`