İçeriğe geç
Dokümantasyon
Api reference

Webhook'lar

Olay aboneliklerini yönetme. Teslimat biçimi ve imza doğrulama için giriş bölümündeki "Webhook'lar" başlığına bakın.

GET
/v1/public-api/webhooks

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Query Parameters

limit?integer
Range0 <= value <= 100
Default20
offset?integer
Range0 <= value
Default0

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X GET 'https://api.getclickfix.com/v1/public-api/webhooks'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}
POST
/v1/public-api/webhooks

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Request Body

application/json
  1. body
name*string
Length1 <= length <= 120
url*string

Public HTTPS URL. Private addresses, redirects and DNS rebinding are blocked.

Formaturi
events*array<string>
Items1 <= items
enabled*boolean

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X POST 'https://api.getclickfix.com/v1/public-api/webhooks' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "url": "http://example.com",  "events": [    "string"  ],  "enabled": true}'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}

Webhook aboneliğini sil

DELETE
/v1/public-api/webhooks/{uuid}

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Path Parameters

uuid*string
Formatuuid

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X DELETE 'https://api.getclickfix.com/v1/public-api/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: string'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}
PUT
/v1/public-api/webhooks/{uuid}

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Path Parameters

uuid*string
Formatuuid

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Request Body

application/json
  1. body
name*string
Length1 <= length <= 120
url*string

Public HTTPS URL. Private addresses, redirects and DNS rebinding are blocked.

Formaturi
events*array<string>
Items1 <= items
enabled*boolean

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X PUT 'https://api.getclickfix.com/v1/public-api/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "url": "http://example.com",  "events": [    "string"  ],  "enabled": true}'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}