API referansı
API referansı — işlem listesi
Public REST API'nin 232 işlemi, etiket bazında; OpenAPI 3.1.0 sözleşmesinden üretilir.
Kaynak: openapi.yaml (OpenAPI 3.1.0, sürüm 1.0.0) · Postman koleksiyonu. İstek/yanıt şemaları, parametreler ve örnekler için OpenAPI dosyasını bir görüntüleyicide (Scalar, Swagger UI, Redoc) açın ya da çalışan API'nin /docs adresini kullanın. Kimlik doğrulama, hata zarfı ve sayfalama kuralları: API'ye genel bakış.
Kapsam gerektiren işlemler Authorization: Bearer hs_live_… ile çağrılır; sdk ve system etiketli uçlar kimliksizdir.
Sistem (system, 4 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | / | Servis bilgisi |
GET | /status.json | Status page (bileşenler ve açık olaylar) |
GET | /healthz | Liveness: süreç ayakta mı? |
GET | /readyz | Readiness: veritabanı ve Redis erişilebilir mi? |
Organizasyon ve app’ler (apps, 7 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/organization | Anahtarın ait olduğu organizasyon (org geneli admin anahtarı) |
GET | /v1/organization/members | Organizasyon üyeleri (org geneli admin anahtarı) |
GET | /v1/organization/audit-logs | Audit log (org geneli admin anahtarı; action/actor/app/tarih filtreleri, cursor) |
GET | /v1/apps | App listesi (org geneli admin anahtarı) |
POST | /v1/apps | App oluştur (org geneli admin anahtarı) |
GET | /v1/apps/{appId} | App detayı |
PATCH | /v1/apps/{appId} | App ayarlarını güncelle |
Organizasyon kullanımı (organization, 1 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/organization/usage | Organizasyon kullanımı ve plan kotaları (org geneli anahtar) |
API anahtarları (api-keys, 5 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/api-keys | App'e bağlı API anahtarları |
POST | /v1/apps/{appId}/api-keys | App'e bağlı API anahtarı oluştur (ham anahtar yalnızca bu yanıtta) |
PATCH | /v1/apps/{appId}/api-keys/{keyId} | Anahtarı güncelle (ad, kapsam, IP izin listesi, bitiş) |
DELETE | /v1/apps/{appId}/api-keys/{keyId} | Anahtarı iptal et |
POST | /v1/apps/{appId}/api-keys/{keyId}/rotate | Anahtarı döndür (eski değer anında geçersiz) |
Kanallar (channels, 3 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/channels | Kanal yapılandırmaları |
PUT | /v1/apps/{appId}/channels/{channel} | Kimlik bilgisi yükle (APNs p8, FCM servis hesabı, VAPID, mock) |
POST | /v1/apps/{appId}/channels/{channel}/validate | Sağlayıcıya test bağlantısı |
Bildirimler (notifications, 8 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/notifications | Mesaj listesi (app_id zorunlu) |
POST | /v1/notifications | Bildirim oluştur (202, asenkron teslimat) |
POST | /v1/notifications/estimate | Kaydedilmemiş hedef için alıcı sayısı (gönderim yapmaz) |
GET | /v1/notifications/{messageId} | Mesaj durumu ve sayaçları |
DELETE | /v1/notifications/{messageId} | Zamanlanmış/kuyruktaki mesajı iptal et |
GET | /v1/notifications/{messageId}/deliveries | Abone bazlı teslimat sonuçları (cursor) |
GET | /v1/notifications/{messageId}/history | Bildirim geçmişi CSV işi (teslimatlar; tamamlanınca download_url) |
POST | /v1/notifications/{messageId}/export_events | Mesaj olay CSV işi (gönderildi/teslim/açıldı/tıklandı/bounce…; tamamlanınca download_url) |
Kullanıcılar, abonelikler ve olaylar (users, 18 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/users | Kullanıcı listesi |
POST | /v1/apps/{appId}/users | Kullanıcı oluştur/güncelle (external_id ile, isteğe bağlı aboneliklerle) |
POST | /v1/apps/{appId}/users/search | Segment tanımı ile kullanıcı arama |
GET | /v1/apps/{appId}/users/by/{label}/{value} | Alias ile kullanıcı (hs_id, external_id veya özel etiket) |
PATCH | /v1/apps/{appId}/users/by/{label}/{value} | Tag/property merge-patch ve deltas |
DELETE | /v1/apps/{appId}/users/by/{label}/{value} | Kullanıcıyı sil (abonelikler silinir, olaylar anonimleşir) |
GET | /v1/apps/{appId}/users/by/{label}/{value}/identity | Kullanıcının tüm kimlikleri (hs_id, external_id, özel alias'lar) |
PATCH | /v1/apps/{appId}/users/by/{label}/{value}/identity | Alias ekle |
GET | /v1/apps/{appId}/users/by/{label}/{value}/export | Kullanıcı verisini dışa aktar (KVKK/GDPR taşınabilirlik): profil, alias, abonelik, son olaylar |
DELETE | /v1/apps/{appId}/users/by/{label}/{value}/identity/{aliasLabel} | Alias kaldır |
POST | /v1/apps/{appId}/users/by/{label}/{value}/subscriptions | Kullanıcıya abonelik ekle |
GET | /v1/apps/{appId}/subscriptions/{subscriptionId} | Abonelik detayı |
PATCH | /v1/apps/{appId}/subscriptions/{subscriptionId} | Abonelik güncelle |
DELETE | /v1/apps/{appId}/subscriptions/{subscriptionId} | Aboneliği sil |
GET | /v1/apps/{appId}/subscriptions/{subscriptionId}/user/identity | Aboneliğin sahibi kullanıcının kimlikleri |
PATCH | /v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token} | Token ile abonelik güncelle (token_type: ios_push, android_push, hms_push, web_push, email, sms veya OneSignal adları iOSPush, AndroidPush, HuaweiPush, ChromePush, FirefoxPush, SafariPush, Email, SMS) |
POST | /v1/apps/{appId}/subscriptions/{subscriptionId}/owner | Aboneliği external_id ile kullanıcıya bağla |
POST | /v1/apps/{appId}/events | Toplu olay gönder (en fazla 500) |
Olay tanımları (events, 3 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/events/definitions | Olay tanımları |
GET | /v1/apps/{appId}/events/definitions/{name} | Olay detayı |
PATCH | /v1/apps/{appId}/events/definitions/{name} | Görünen ad / dönüşüm işareti |
Segmentler (segments, 8 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/segments | Segment listesi |
POST | /v1/apps/{appId}/segments | Segment oluştur |
POST | /v1/apps/{appId}/segments/preview | Tanım ile sayım ve örnek kullanıcılar |
GET | /v1/apps/{appId}/segments/{segmentId} | Segment detayı |
PATCH | /v1/apps/{appId}/segments/{segmentId} | Segment güncelle |
DELETE | /v1/apps/{appId}/segments/{segmentId} | Segment sil |
GET | /v1/apps/{appId}/segments/{segmentId}/campaigns | Segmenti kullanan kampanyalar |
POST | /v1/apps/{appId}/segments/{segmentId}/estimate | Tahmini sayım |
Şablonlar (templates, 9 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/templates | Şablon listesi |
POST | /v1/apps/{appId}/templates | Şablon oluştur |
GET | /v1/apps/{appId}/templates/{templateId} | Şablon detayı |
PATCH | /v1/apps/{appId}/templates/{templateId} | Şablon güncelle |
DELETE | /v1/apps/{appId}/templates/{templateId} | Şablon sil |
GET | /v1/apps/{appId}/templates/{templateId}/stats | Şablon analitiği |
POST | /v1/apps/{appId}/templates/{templateId}/copy_to_app | Şablonu aynı organizasyondaki başka bir app'e kopyala |
GET | /v1/apps/{appId}/templates/{templateId}/versions | Sürüm geçmişi |
POST | /v1/apps/{appId}/templates/{templateId}/render | Şablonu örnek verilerle render et |
Kampanyalar (campaigns, 18 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/campaigns | Kampanya listesi |
POST | /v1/apps/{appId}/campaigns | Kampanya oluştur |
GET | /v1/apps/{appId}/campaigns/{campaignId} | Kampanya detayı |
PATCH | /v1/apps/{appId}/campaigns/{campaignId} | Kampanya güncelle |
DELETE | /v1/apps/{appId}/campaigns/{campaignId} | Kampanya sil |
POST | /v1/apps/{appId}/campaigns/{campaignId}/schedule | Zamanla |
POST | /v1/apps/{appId}/campaigns/{campaignId}/send | Hemen gönder |
POST | /v1/apps/{appId}/campaigns/{campaignId}/pause | Duraklat |
POST | /v1/apps/{appId}/campaigns/{campaignId}/resume | Sürdür |
POST | /v1/apps/{appId}/campaigns/{campaignId}/cancel | İptal |
POST | /v1/apps/{appId}/campaigns/{campaignId}/duplicate | Çoğalt |
POST | /v1/apps/{appId}/campaigns/{campaignId}/approve | Onayla |
GET | /v1/apps/{appId}/campaigns/{campaignId}/stats | İstatistikler |
GET | /v1/apps/{appId}/campaigns/{campaignId}/variants/stats | A/B varyant karşılaştırması |
POST | /v1/apps/{appId}/campaigns/{campaignId}/winner | A/B kazananını seç |
GET | /v1/apps/{appId}/campaigns/{campaignId}/deliveries | Abone bazlı teslimatlar |
POST | /v1/apps/{appId}/campaigns/{campaignId}/resend-failed | Başarısız teslimatlara yeniden gönder |
GET | /v1/apps/{appId}/campaigns/{campaignId}/messages | Kampanya çalıştırmaları |
Journey’ler (journeys, 19 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/journeys | Journey listesi |
POST | /v1/apps/{appId}/journeys | Journey oluştur (taslak) |
GET | /v1/apps/{appId}/journeys/{journeyId} | Journey detayı |
PATCH | /v1/apps/{appId}/journeys/{journeyId} | Ad / açıklama |
DELETE | /v1/apps/{appId}/journeys/{journeyId} | Hiç yayınlanmamış journey'i sil |
PUT | /v1/apps/{appId}/journeys/{journeyId}/draft | Taslağı kaydet |
PATCH | /v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId} | Taslaktaki düğümü güncelle |
GET | /v1/apps/{appId}/journeys/{journeyId}/versions | Sürümler |
POST | /v1/apps/{appId}/journeys/{journeyId}/publish | Yayınla |
POST | /v1/apps/{appId}/journeys/{journeyId}/pause | Duraklat |
POST | /v1/apps/{appId}/journeys/{journeyId}/resume | Devam ettir |
POST | /v1/apps/{appId}/journeys/{journeyId}/archive | Arşivle |
POST | /v1/apps/{appId}/journeys/{journeyId}/duplicate | Kopyala |
GET | /v1/apps/{appId}/journeys/{journeyId}/stats | Düğüm bazlı istatistik |
GET | /v1/apps/{appId}/journeys/{journeyId}/runs | Run listesi |
POST | /v1/apps/{appId}/journeys/{journeyId}/runs | Kullanıcıyı journey'e sok (external_id, user_id veya alias; context Liquid custom_data) |
GET | /v1/apps/{appId}/journeys/{journeyId}/runs/{runId} | Run detayı ve adımlar |
DELETE | /v1/apps/{appId}/journeys/{journeyId}/runs/{runId} | Run'ı sonlandır |
GET | /v1/apps/{appId}/users/by/{label}/{value}/journeys | Kullanıcının journey run'ları |
In-app mesajlar (in-app, 7 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/in-app-messages | In-app mesajlar (durum filtresi; istatistik dahil) |
POST | /v1/apps/{appId}/in-app-messages | In-app mesaj oluştur (taslak) |
GET | /v1/apps/{appId}/in-app-messages/{messageId} | In-app mesaj detayı ve istatistikleri |
PATCH | /v1/apps/{appId}/in-app-messages/{messageId} | In-app mesajı düzenle |
DELETE | /v1/apps/{appId}/in-app-messages/{messageId} | In-app mesajı sil |
POST | /v1/apps/{appId}/in-app-messages/{messageId}/status | Yayınla / duraklat / arşivle |
POST | /v1/apps/{appId}/in-app-messages/{messageId}/winner | A/B kazananını elle seç |
Bildirim kutusu (inbox, 4 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/users/by/{label}/{value}/inbox | Kullanıcının bildirim kutusu (okunmamış sayısı dahil) |
POST | /v1/apps/{appId}/users/by/{label}/{value}/inbox/read-all | Tümünü okundu işaretle |
POST | /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/read | Okundu işaretle |
DELETE | /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId} | Kutudan kaldır (arşivle) |
Kategoriler ve tercihler (preferences, 6 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/categories | Mesaj kategorileri |
POST | /v1/apps/{appId}/categories | Kategori oluştur |
PATCH | /v1/apps/{appId}/categories/{categoryId} | Kategori güncelle |
DELETE | /v1/apps/{appId}/categories/{categoryId} | Kategori sil |
GET | /v1/apps/{appId}/users/by/{label}/{value}/preferences | Kullanıcının tercihleri (alias ile) |
PUT | /v1/apps/{appId}/users/by/{label}/{value}/preferences | Kullanıcı tercihlerini yaz (alias ile) |
Suppression list (suppressions, 3 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/suppressions | Suppression list (e-posta/SMS gönderilmeyecek adresler; kanal/neden/değer filtresi) |
POST | /v1/apps/{appId}/suppressions | Adres ekle (manuel engel; değer saklanmaz, özet + maskeli gösterim) |
DELETE | /v1/apps/{appId}/suppressions/{suppressionId} | Kaydı kaldır (adres yeniden gönderim alabilir) |
Webhook’lar (webhooks, 10 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/webhooks | Webhook endpoint'leri |
POST | /v1/apps/{appId}/webhooks | Endpoint oluştur (secret yalnızca bu yanıtta döner) |
POST | /v1/apps/{appId}/webhooks/preview | Event Streams önizlemesi: örnek olay + şablon + filtre → gövde/hata (gönderim yapmaz) |
GET | /v1/apps/{appId}/webhooks/{webhookId} | Endpoint detayı |
PATCH | /v1/apps/{appId}/webhooks/{webhookId} | Endpoint güncelle (URL, olaylar, batch, başlıklar, etkinleştir/durdur) |
DELETE | /v1/apps/{appId}/webhooks/{webhookId} | Endpoint sil |
POST | /v1/apps/{appId}/webhooks/{webhookId}/rotate-secret | Secret rotasyonu (eski secret 24 saat ikinci imza olarak gönderilir) |
POST | /v1/apps/{appId}/webhooks/{webhookId}/test | Test olayı gönder (anında, sonuç döner) |
GET | /v1/apps/{appId}/webhooks/{webhookId}/deliveries | Teslim geçmişi (cursor; durum/olay türü filtresi) |
POST | /v1/apps/{appId}/webhooks/deliveries/{deliveryId}/replay | Teslimi yeniden gönder (aynı olay kimliğiyle) |
Analitik (analytics, 9 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/analytics/overview | Genel bakış KPI |
GET | /v1/apps/{appId}/analytics/messages | Teslimat raporu |
GET | /v1/apps/{appId}/analytics/subscriptions | Abonelik büyümesi |
GET | /v1/apps/{appId}/analytics/events | Olay hacmi |
GET | /v1/apps/{appId}/analytics/conversions | Dönüşüm/atribüsyon |
POST | /v1/apps/{appId}/analytics/funnels | Funnel |
GET | /v1/apps/{appId}/analytics/providers | Sağlayıcı sağlığı |
GET | /v1/apps/{appId}/analytics/retention | Retention kohortu |
GET | /v1/apps/{appId}/analytics/engagement | Etkileşim ısı haritası |
Dışa / içe aktarma (exports, 6 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/exports | Export işleri |
POST | /v1/apps/{appId}/exports | Export işi başlat |
GET | /v1/apps/{appId}/exports/{exportId} | Export durumu (download_url) |
GET | /v1/apps/{appId}/imports | Import işleri |
POST | /v1/apps/{appId}/imports | Import işi başlat (multipart: type, file) |
GET | /v1/apps/{appId}/imports/{importId} | Import durumu |
SDK uçları (istemci; API anahtarı gerekmez) (sdk, 25 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /sdk/v1/apps/{appId}/config | SDK için public app yapılandırması |
POST | /sdk/v1/apps/{appId}/subscriptions | Cihaz/kanal kaydı (idempotent: aynı token tek abonelik) |
PATCH | /sdk/v1/apps/{appId}/subscriptions/{subscriptionId} | Token yenileme, cihaz bilgisi, opt-in/out (sahiplik kanıtı: token_hash veya identity_hash) |
DELETE | /sdk/v1/apps/{appId}/subscriptions/{subscriptionId} | Aboneliği sil (sahiplik kanıtı: token_hash veya identity_hash) |
POST | /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/login | Cihazı external_id ile kullanıcıya bağla (anonim kullanıcı birleştirilir; sahiplik kanıtı: token_hash) |
POST | /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logout | Cihazı anonim yeni kullanıcıya taşı (sahiplik kanıtı: token_hash veya identity_hash) |
PATCH | /sdk/v1/apps/{appId}/users/{userId} | Tag/property merge-patch (identity verification zorunluysa hash gerekir) |
PATCH | /sdk/v1/apps/{appId}/users/{userId}/identity | Kullanıcıya alias ekle (User.addAlias; identity verification zorunluysa hash) |
DELETE | /sdk/v1/apps/{appId}/users/{userId}/identity/{label} | Kullanıcıdan alias kaldır (User.removeAlias) |
POST | /sdk/v1/apps/{appId}/sessions | Oturum başlangıcı (süre yoksa) veya bitişi (süre ile; sahiplik kanıtı: token_hash veya identity_hash) |
POST | /sdk/v1/apps/{appId}/events | Toplu olay bildirimi (en fazla 100) |
POST | /sdk/v1/apps/{appId}/deliveries/{deliveryId}/received | Cihaz bildirimi aldı (confirmed delivery) |
POST | /sdk/v1/apps/{appId}/deliveries/{deliveryId}/dismissed | Bildirim kullanıcı tarafından kapatıldı (web notificationclose, Android silme) |
POST | /sdk/v1/apps/{appId}/deliveries/{deliveryId}/opened | Bildirim açıldı / düğmeye tıklandı |
POST | /sdk/v1/apps/{appId}/live-activities/tokens | Live Activity belirteci kaydet (push-to-start veya etkinlik güncelleme) |
POST | /sdk/v1/apps/{appId}/live-activities/tokens/delete | Live Activity belirtecini sil (etkinlik bitti veya izin kaldırıldı) |
POST | /sdk/v1/apps/{appId}/errors | SDK hata raporları (en fazla 20; 7 gün saklanır) |
GET | /sdk/v1/apps/{appId}/in-app | Cihaz için gösterilebilecek in-app mesajlar (tetikleri SDK değerlendirir) |
POST | /sdk/v1/apps/{appId}/in-app/{messageId}/events | In-app gösterim / tıklama / kapatma |
GET | /sdk/v1/apps/{appId}/users/{userId}/inbox | Bildirim kutusu (abonelik kullanıcıya ait olmalı; gerekirse identity_hash) |
POST | /sdk/v1/apps/{appId}/users/{userId}/inbox/read-all | Tümünü okundu işaretle |
POST | /sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/read | Okundu işaretle |
DELETE | /sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId} | Kutudan kaldır (arşivle) |
GET | /sdk/v1/apps/{appId}/preferences | Cihaz kullanıcısının tercihleri ve kategoriler |
PUT | /sdk/v1/apps/{appId}/preferences | Cihaz kullanıcısının tercihlerini yaz |
identity-keys (identity-keys, 3 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/identity-keys | SDK kimlik doğrulama (JWT) genel anahtarları |
POST | /v1/apps/{appId}/identity-keys | Genel anahtar ekle (ES256) |
DELETE | /v1/apps/{appId}/identity-keys/{keyId} | Genel anahtarı iptal et |
live-activities (live-activities, 7 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/live-activities/types | Live Activity türleri |
POST | /v1/apps/{appId}/live-activities/types | Live Activity türü oluştur |
PATCH | /v1/apps/{appId}/live-activities/types/{activityType} | Live Activity türünü güncelle |
DELETE | /v1/apps/{appId}/live-activities/types/{activityType} | Live Activity türünü sil |
POST | /v1/apps/{appId}/live-activities/{activityType}/start | Live Activity başlat (push-to-start) |
POST | /v1/apps/{appId}/live-activities/{activityType}/update | Live Activity güncelle |
POST | /v1/apps/{appId}/live-activities/{activityType}/end | Live Activity bitir |
dynamic-content (dynamic-content, 13 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/data-feeds | Data feed listesi |
POST | /v1/apps/{appId}/data-feeds | Data feed oluştur |
GET | /v1/apps/{appId}/data-feeds/{feedId} | Data feed ayrıntısı |
PATCH | /v1/apps/{appId}/data-feeds/{feedId} | Data feed güncelle |
DELETE | /v1/apps/{appId}/data-feeds/{feedId} | Data feed sil |
POST | /v1/apps/{appId}/data-feeds/{feedId}/test | Data feed'i örnek kullanıcıyla dene |
GET | /v1/apps/{appId}/content-tables | İçerik tabloları |
POST | /v1/apps/{appId}/content-tables | CSV ile içerik tablosu oluştur |
GET | /v1/apps/{appId}/content-tables/{tableId} | İçerik tablosu ayrıntısı |
PATCH | /v1/apps/{appId}/content-tables/{tableId} | İçerik tablosu açıklamasını güncelle |
DELETE | /v1/apps/{appId}/content-tables/{tableId} | İçerik tablosunu sil |
GET | /v1/apps/{appId}/content-tables/{tableId}/rows | İçerik tablosu satırları |
PUT | /v1/apps/{appId}/content-tables/{tableId}/rows | İçerik tablosunu yeniden yükle (sürüm artar) |
warehouse (warehouse, 10 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/warehouse-exports/tables | Dışa aktarılabilir tablolar, kolonlar ve şema sürümleri |
POST | /v1/apps/{appId}/warehouse-exports/test-connection | Kaydetmeden bağlantı testi |
GET | /v1/apps/{appId}/warehouse-exports | Veri ambarı dışa aktarımları |
POST | /v1/apps/{appId}/warehouse-exports | Dışa aktarım oluştur (kimlik bilgisi şifreli saklanır, yanıtta dönmez) |
GET | /v1/apps/{appId}/warehouse-exports/{exportId} | Dışa aktarım detayı |
PATCH | /v1/apps/{appId}/warehouse-exports/{exportId} | Dışa aktarımı güncelle (ad, tablolar, zamanlama, etkin/duraklat, hedef ayarı, kimlik bilgisi) |
DELETE | /v1/apps/{appId}/warehouse-exports/{exportId} | Dışa aktarımı sil (hedefteki veriler silinmez) |
POST | /v1/apps/{appId}/warehouse-exports/{exportId}/test | Kayıtlı dışa aktarımın bağlantı testi |
POST | /v1/apps/{appId}/warehouse-exports/{exportId}/run | Şimdi çalıştır (son başarılı imleçten itibaren) |
GET | /v1/apps/{appId}/warehouse-exports/{exportId}/runs | Çalıştırma geçmişi (cursor) |
conversations (conversations, 11 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/conversations | Konuşmalar (SMS, WhatsApp, RCS; son mesaja göre; kanal/durum/okunmamış/kişi filtresi) |
GET | /v1/apps/{appId}/conversations/{conversationId} | Konuşma (WhatsApp oturum penceresi ve açık rıza durumu dahil) |
GET | /v1/apps/{appId}/conversations/{conversationId}/messages | Konuşma mesajları (yeniden eskiye; giden mesaj durumu teslimattan) |
POST | /v1/apps/{appId}/conversations/{conversationId}/messages | Yanıt gönder. WhatsApp: açık rıza zorunlu; son gelen mesajdan 24 saat içinde metin/medya, pencere dışında yalnızca onaylı şablon (aksi 422 WHATSAPP_WINDOW_CLOSED). |
POST | /v1/apps/{appId}/conversations/{conversationId}/read | Gelen mesajları okundu işaretle |
GET | /v1/apps/{appId}/sms-keywords | İki yönlü mesaj anahtar sözcükleri (org geneli + bu app) ve yasal (ayrılmış) sözcükler |
POST | /v1/apps/{appId}/sms-keywords | Anahtar sözcük oluştur (tag ekle/kaldır, olay → journey tetiği, otomatik yanıt, abonelik) |
PATCH | /v1/apps/{appId}/sms-keywords/{keywordId} | Anahtar sözcüğü güncelle |
DELETE | /v1/apps/{appId}/sms-keywords/{keywordId} | Anahtar sözcüğü sil |
GET | /v1/apps/{appId}/whatsapp/templates | WhatsApp şablonları (Meta onay durumu ile) |
POST | /v1/apps/{appId}/whatsapp/templates/sync | WhatsApp şablonlarını Meta Graph API’den senkronla |
email-deliverability (email-deliverability, 9 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/email-deliverability | E-posta teslim ayarları (BCC/arşiv, gönderim öncesi adres doğrulama, üçüncü taraf doğrulayıcı) |
PUT | /v1/apps/{appId}/email-deliverability | E-posta teslim ayarlarını güncelle (doğrulayıcı anahtarı zarf şifreli saklanır, geri okunmaz) |
POST | /v1/apps/{appId}/email-deliverability/verify-address | Adres doğrulama testi (sözdizimi, MX, tek kullanımlık alan adı, rol hesabı, üçüncü taraf) |
GET | /v1/apps/{appId}/email-deliverability/warmup-plans | Isındırma planları (bugünkü limit/kullanım ve ileri günlere ayrılmış gönderimler) |
POST | /v1/apps/{appId}/email-deliverability/warmup-plans | Isındırma planı oluştur (günlük limit eğrisi veya başlangıç/çarpan/hedef; sağlayıcı payları) |
GET | /v1/apps/{appId}/email-deliverability/warmup-plans/{planId} | Isındırma planı |
PATCH | /v1/apps/{appId}/email-deliverability/warmup-plans/{planId} | Isındırma planını güncelle (duraklat/sürdür, eğri, paylar) |
DELETE | /v1/apps/{appId}/email-deliverability/warmup-plans/{planId} | Isındırma planını sil |
GET | /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usage | Isındırma planı gün × sağlayıcı kullanımı |
integrations (integrations, 4 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
GET | /v1/apps/{appId}/integrations/zapier/me | Zapier bağlantı testi: anahtarın app’i ve kapsamları |
POST | /v1/apps/{appId}/integrations/zapier/hooks | REST 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/samples | Tetik örnekleri (performList): son kayıtlar, abonelik gövdesiyle aynı biçim |
mcp (mcp, 2 işlem)
| Yöntem | Yol | Açıklama |
|---|---|---|
POST | /v1/apps/{appId}/mcp/campaign-drafts | Kampanya taslağı oluştur (MCP onaylı mod; gönderim yapmaz) |
POST | /v1/apps/{appId}/mcp/segment-drafts | Segment taslağı oluştur (MCP onaylı mod; dinamik segment) |
API'ye genel bakış
Kimlik doğrulama, kapsamlar, hata zarfı, idempotency, hız sınırı, sayfalama; OpenAPI sözleşmesi ve Postman koleksiyonu.
Webhook'lar
Pushizo, app'inizdeki olayları (teslimat, açılma, abonelik, kullanıcı, olay, dönüşüm, kampanya) HTTPS üzerinden sizin sunucunuza imzalı olarak iletir. Endpoint'ler dashboard'da Geliştirici → Webhooks ekranından ya da…