PushizoDocs
API referansı

Entegrasyonlar

Entegrasyonlar — 4 işlem (GET /v1/apps/{appId}/integrations/zapier/me, POST /v1/apps/{appId}/integrations/zapier/hooks, DELETE /v1/apps/{appId}/integrations/zapier/hooks/{hookId}, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Hazır entegrasyonlar: Zapier tetikleyici abonelikleri ve analitik hedefleri (Segment, Amplitude, Mixpanel).

Taban adres: https://api.pushizo.com · Etiket: integrations · Etkileşimli belge (Scalar)

İşlemler

YöntemYolİşlem
GET/v1/apps/{appId}/integrations/zapier/meZapier bağlantı testi: anahtarın app’i ve kapsamları
POST/v1/apps/{appId}/integrations/zapier/hooksREST Hook aboneliği (Zap açıldı)
DELETE/v1/apps/{appId}/integrations/zapier/hooks/{hookId}REST Hook aboneliğini sil (Zap kapatıldı)
GET/v1/apps/{appId}/integrations/zapier/samplesTetik örnekleri (performList): son kayıtlar, abonelik gövdesiyle aynı biçim

Ayrıntılar

Zapier bağlantı testi: anahtarın app’i ve kapsamları

GET/v1/apps/{appId}/integrations/zapier/meDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: ZapierMe

AlanTürZorunluAçıklama
app_idstringEvet
app_namestringEvet
org_idstringEvet
scopesarray<string>Evet

Örnek yanıt:

{
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_name": "örnek",
  "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "scopes": [
    "notifications:write"
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/integrations/zapier/me" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

REST Hook aboneliği (Zap açıldı)

POST/v1/apps/{appId}/integrations/zapier/hooksDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: ZapierSubscribeDto

AlanTürZorunluAçıklama
target_urlstringEvetUzunluk: 1–2000
eventenumEvetDeğerler: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed"
event_namestringHayırUzunluk: 1–100

Örnek:

{
  "target_url": "https://example.com/orders/1001",
  "event": "subscription.created",
  "event_name": "purchase"
}

Yanıtlar

201 — Başarılı.

Şema: ZapierHook

AlanTürZorunluAçıklama
idstringEvet
eventstringEvet
event_namestring | nullEvet
target_urlstringEvet
last_delivered_atstring | nullEvet
failure_countintegerEvet
created_atstringEvet

Örnek yanıt:

{
  "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "event": "purchase",
  "event_name": "purchase",
  "target_url": "https://example.com/orders/1001",
  "last_delivered_at": "örnek",
  "failure_count": 1,
  "created_at": "örnek"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/integrations/zapier/hooks" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target_url": "https://example.com/orders/1001",
  "event": "subscription.created",
  "event_name": "purchase"
}'

REST Hook aboneliğini sil (Zap kapatıldı)

DELETE/v1/apps/{appId}/integrations/zapier/hooks/{hookId}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
hookIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: IntegrationOk

AlanTürZorunluAçıklama
oktrueEvet

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/integrations/zapier/hooks/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Tetik örnekleri (performList): son kayıtlar, abonelik gövdesiyle aynı biçim

GET/v1/apps/{appId}/integrations/zapier/samplesDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
eventsorguenumEvetDeğerler: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed""subscription.created"
event_namesorgustringHayırUzunluk: 1–100"purchase"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: ZapierSamples

Tür: ZapierSamples

Örnek yanıt:

[
  {
    "data": {
      "order_id": "1001"
    },
    "type": "örnek",
    "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "created_at": "örnek",
    "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  }
]

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/integrations/zapier/samples?event=subscription.created" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Bu sayfada