Skip to content
Ideasoft
Admin API

ClientWebhook

Serverhttps://your-store.myideasoft.com

ClientWebhook LIST

GET
https://your-store.myideasoft.com
/admin-api/client_webhooks
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki client webhookları listelemek ve çeşitli kriterlere göre filtrelemek için kullanılır. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId), topic ve arama (s) parametreleriyle özelleştirilebilir.

ClientWebhook LIST › query Parameters

sort
​string

Sonuçların sıralama biçimi. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek webhook sayısı. Varsayılan 20

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı. Varsayılan 1

Default: 1
sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir

topic
​string

Webhook Topic

c_predefined
​string

Client Predefined filtreleme

c_name
​string

Client Name filtreleme

s
​string

Genel arama anahtarı ile filtreleme

ClientWebhook LIST › Responses

The request (GET or PUT) completed successfully.

topic
​string · enum · maxLength: 255 · required

Webhook’un tetiklendiği olay.

Enum values:
product/delete
product/update
product/create
order/create
order/update
order/delete
payment/create
payment/update
Example: product/create
address
​string · maxLength: 255 · required

Olay gerçekleştiğinde POST isteği gönderilecek hedef URI.

status
​integer · enum · required

Webhook aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Webhook kimlik değeri.

​ClientSummary
createdAt
​string · date-time

Webhook oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Webhook güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

ClientWebhook POST

POST
https://your-store.myideasoft.com
/admin-api/client_webhooks
Bearer
or
OAuth 2.0

Yeni bir client webhook kaydı oluşturur ve log kaydı oluşturur.

ClientWebhook POST › Request Body

topic
​string · enum · maxLength: 255 · required

Webhook’un tetiklendiği olay.

Enum values:
product/delete
product/update
product/create
order/create
order/update
order/delete
payment/create
payment/update
Example: product/create
address
​string · maxLength: 255 · required

Olay gerçekleştiğinde POST isteği gönderilecek hedef URI.

status
​integer · enum · required

Webhook aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Webhook kimlik değeri.

​ClientSummary
createdAt
​string · date-time

Webhook oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Webhook güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

ClientWebhook POST › Responses

The create request (POST) completed successfully.

topic
​string · enum · maxLength: 255 · required

Webhook’un tetiklendiği olay.

Enum values:
product/delete
product/update
product/create
order/create
order/update
order/delete
payment/create
payment/update
Example: product/create
address
​string · maxLength: 255 · required

Olay gerçekleştiğinde POST isteği gönderilecek hedef URI.

status
​integer · enum · required

Webhook aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Webhook kimlik değeri.

​ClientSummary
createdAt
​string · date-time

Webhook oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Webhook güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

ClientWebhook COUNT

GET
https://your-store.myideasoft.com
/admin-api/client_webhooks/count
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki client webhookları listelemek ve çeşitli kriterlere göre filtrelemek için kullanılır. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId), topic ve arama (s) parametreleriyle özelleştirilebilir.

ClientWebhook COUNT › query Parameters

sort
​string

Sonuçların sıralama biçimi. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek webhook sayısı. Varsayılan 20

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı. Varsayılan 1

Default: 1
sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir

topic
​string

Webhook Topic

c_predefined
​string

Client Predefined filtreleme

c_name
​string

Client Name filtreleme

s
​string

Genel arama anahtarı ile filtreleme

ClientWebhook COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


ClientWebhook GET

GET
https://your-store.myideasoft.com
/admin-api/client_webhooks/{id}
Bearer
or
OAuth 2.0

Belirtilen ID ile eşleşen client webhook kaydını döndürür.

ClientWebhook GET › path Parameters

id
​string · pattern: \d+ · required

Client webhook kaydının ID değeri

ClientWebhook GET › Responses

The request (GET or PUT) completed successfully.

topic
​string · enum · maxLength: 255 · required

Webhook’un tetiklendiği olay.

Enum values:
product/delete
product/update
product/create
order/create
order/update
order/delete
payment/create
payment/update
Example: product/create
address
​string · maxLength: 255 · required

Olay gerçekleştiğinde POST isteği gönderilecek hedef URI.

status
​integer · enum · required

Webhook aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Webhook kimlik değeri.

​ClientSummary
createdAt
​string · date-time

Webhook oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Webhook güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

ClientWebhook PUT

PUT
https://your-store.myideasoft.com
/admin-api/client_webhooks/{id}
Bearer
or
OAuth 2.0

Belirtilen client webhook kaydını günceller ve log kaydı oluşturur.

ClientWebhook PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek client webhook kaydının ID değeri

ClientWebhook PUT › Request Body

topic
​string · enum · maxLength: 255 · required

Webhook’un tetiklendiği olay.

Enum values:
product/delete
product/update
product/create
order/create
order/update
order/delete
payment/create
payment/update
Example: product/create
address
​string · maxLength: 255 · required

Olay gerçekleştiğinde POST isteği gönderilecek hedef URI.

status
​integer · enum · required

Webhook aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Webhook kimlik değeri.

​ClientSummary
createdAt
​string · date-time

Webhook oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Webhook güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

ClientWebhook PUT › Responses

The request (GET or PUT) completed successfully.

topic
​string · enum · maxLength: 255 · required

Webhook’un tetiklendiği olay.

Enum values:
product/delete
product/update
product/create
order/create
order/update
order/delete
payment/create
payment/update
Example: product/create
address
​string · maxLength: 255 · required

Olay gerçekleştiğinde POST isteği gönderilecek hedef URI.

status
​integer · enum · required

Webhook aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Webhook kimlik değeri.

​ClientSummary
createdAt
​string · date-time

Webhook oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Webhook güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

ClientWebhook DELETE

DELETE
https://your-store.myideasoft.com
/admin-api/client_webhooks/{id}
Bearer
or
OAuth 2.0

Belirtilen client webhook kaydını siler ve log kaydı oluşturur.

ClientWebhook DELETE › path Parameters

id
​string · pattern: \d+ · required

Silinecek client webhook kaydının ID değeri

ClientWebhook DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned