Mendapatkan daftar langganan webhook

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Otorisasi

api-token + language + role

Parameter permintaan

branch_idinteger

Contoh: 8412

Tanggapan

object

statusstringwajib

Nilai:successerror

Contoh: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object

valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

settingsobject (WebhooksBranchSettings)

secretstringdapat bernilai null

null, sampai jaringan membuat secret

Contoh: 9f2c…

enabledbooleanwajib

Contoh: true

listarray of object

idintegerwajib

Contoh: 12

date_creationstring (DataTimeFormatSQL) wajib

Contoh: 2024-05-02 08:31:16

webhook_event_idintegerwajib

Contoh: 4

slugstringwajib

Kode event yang dikirimkan dalam body webhook

Contoh: order.created

translation_keystringwajib

Kunci terjemahan nama event

Contoh: webhooksSubscriptionsEvent.orderCreated

urlstringwajib

Contoh: https://partner.example.com/hooks/foodsoul

descriptionstringwajib

Contoh: Учётная система

enabledbooleanwajib

Contoh: true

blockedbooleanwajib

Langganan dinonaktifkan secara otomatis setelah serangkaian kesalahan

Contoh: false

count_errorsintegerwajib

Jumlah kegagalan pengiriman berturut-turut

Contoh: 0

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'id', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/webhooks_subscriptions", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "id", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/webhooks_subscriptions", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "id", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "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 } ] } }