API başvurusu

Organizasyon

Bu gruptaki 15 uç.

Organizasyon ayarlarını getirir

GET/api/v1/organization

Plan, marka, gönderim politikası, çalışma saatleri, SLA, test modu, saklama süresi ve askı durumu döner. Ödeme kimlikleri ve anahtarlar dönmez. Yönetici yetkisi gerekir. Kapsam: organization:read.

Kapsam
organization:read
SDK metodu
getOrganization · get_organization
MCP aracı
getOrganizationsalt okunur

Örnek istek

curl -X GET "https://hiboty.com/api/v1/organization" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "slug": "string",
    "plan": "string",
    "brand": {
      "name": "Hiboty",
      "logo_url": "https://example.com/a.png",
      "color": "string"
    },
    "timezone": "Europe/Istanbul",
    "campaign_frequency_hours": 1,
    "quiet_hours_start": 1,
    "quiet_hours_end": 1,
    "campaign_four_eyes": true,
    "business_hours": {
      "days": [
        1
      ],
      "start": "string",
      "end": "string",
      "message": "string"
    },
    "csat": {
      "question": "string",
      "thank_you": "string"
    },
    "sla_target_minutes": 1,
    "sla_escalation": true,
    "test_mode": true,
    "data_retention_days": 1,
    "suspended": true,
    "suspended_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "legal_hold": true,
    "legal_hold_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Organizasyon ayarlarını günceller

PATCH/api/v1/organization

Yalnız gönderilen alanlar değişir; bir alan geçersizse hiçbiri yazılmaz. test_mode açıkken giden mesajlar kanala gönderilmez; kısa data_retention_days eski konuşma verisini kalıcı siler. campaign_four_eyes (dört göz) API ile yazılamaz: gönderim onay denetimi panelde kalır. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
updateOrganization · update_organization
MCP aracı
updateOrganizationdış etkiligeri alınamaz

Gövde alanları

AdTürZorunluAçıklama
namestringhayırlen 2–80
brandobjecthayır
brand.namestring | nullhayırlen ≤ 60
brand.logo_urlstring | nullhayırhttps adresi ya da yüklenen görselin path değerilen ≤ 1000
brand.colorstring | nullhayır#RRGGBB
timezonestringhayırIANA saat dilimi
campaign_frequency_hoursenumhayır0 | 12 | 24 | 48 | 72 | 168
quiet_hours_startinteger | nullhayırval 0–23
quiet_hours_endinteger | nullhayırval 0–23
business_hoursobject | nullhayırnull: kapalı
business_hours.daysinteger[]evet
business_hours.startstringevetSS:DD
business_hours.endstringevetSS:DD
business_hours.messagestringevet
csatobject | nullhayırnull: kapalı
csat.questionstringevet
csat.thank_youstringevet
sla_target_minutesenumhayır5 | 15 | 30 | 60 | 120 | 240 | 480 | 1440
sla_escalationbooleanhayır
test_modebooleanhayır
data_retention_daysenumhayırnull: süresiz90 | 180 | 365 | 730 | null

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/organization" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Örnek Mağaza","timezone":"Europe/Istanbul","quiet_hours_start":22,"quiet_hours_end":8,"sla_target_minutes":30}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "slug": "string",
    "plan": "string",
    "brand": {
      "name": "Hiboty",
      "logo_url": "https://example.com/a.png",
      "color": "string"
    },
    "timezone": "Europe/Istanbul",
    "campaign_frequency_hours": 1,
    "quiet_hours_start": 1,
    "quiet_hours_end": 1,
    "campaign_four_eyes": true,
    "business_hours": {
      "days": [
        1
      ],
      "start": "string",
      "end": "string",
      "message": "string"
    },
    "csat": {
      "question": "string",
      "thank_you": "string"
    },
    "sla_target_minutes": 1,
    "sla_escalation": true,
    "test_mode": true,
    "data_retention_days": 1,
    "suspended": true,
    "suspended_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "legal_hold": true,
    "legal_hold_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

İçerik politikasını getirir

GET/api/v1/organization/content-policy

Kapalı olsa da kayıtlı politika döner. Yönetici yetkisi gerekir. Kapsam: organization:read.

Kapsam
organization:read
SDK metodu
getContentPolicy · get_content_policy
MCP aracı
getContentPolicysalt okunur

Örnek istek

curl -X GET "https://hiboty.com/api/v1/organization/content-policy" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "enabled": true,
    "blocked_phrases": [
      "string"
    ],
    "warned_phrases": [
      "string"
    ],
    "allowed_domains": [
      "string"
    ],
    "blocked_domains": [
      "string"
    ],
    "max_links": 1,
    "max_caps_percent": 1
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

İçerik politikasını değiştirir

PUT/api/v1/organization/content-policy

Politikanın tamamı değişir: gönderilmeyen liste boşalır, gönderilmeyen sınır kalkar. Değerler sabit dizgidir, düzenli ifade kabul edilmez. Açıksa kampanya ve planlı gönderiler bu kurallarla denetlenir. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
updateContentPolicy · update_content_policy
MCP aracı
updateContentPolicy

Gövde alanları

AdTürZorunluAçıklama
enabledbooleanevet
blocked_phrasesstring[]hayırEn fazla 300 ifade
warned_phrasesstring[]hayırEn fazla 300 ifade
allowed_domainsstring[]hayırEn fazla 200 alan adı
blocked_domainsstring[]hayırEn fazla 200 alan adı
max_linksinteger | nullhayırval 0–20
max_caps_percentinteger | nullhayırval 10–100

Örnek istek

curl -X PUT "https://hiboty.com/api/v1/organization/content-policy" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"blocked_phrases":["garantili kazanç"],"warned_phrases":["son fırsat"],"allowed_domains":["ornek.com"],"blocked_domains":[],"max_links":2,"max_caps_percent":60}'

Örnek yanıt (200)

JSON
{
  "data": {
    "enabled": true,
    "blocked_phrases": [
      "string"
    ],
    "warned_phrases": [
      "string"
    ],
    "allowed_domains": [
      "string"
    ],
    "blocked_domains": [
      "string"
    ],
    "max_links": 1,
    "max_caps_percent": 1
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

AI ayarlarını getirir

GET/api/v1/organization/ai

Anahtarlar hiçbir zaman okunmaz; yalnız *_key_set döner. Yönetici yetkisi gerekir. Kapsam: organization:read.

Kapsam
organization:read
SDK metodu
getAiSettings · get_ai_settings
MCP aracı
getAiSettingssalt okunur

Örnek istek

curl -X GET "https://hiboty.com/api/v1/organization/ai" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "provider": "string",
    "model": "string",
    "monthly_limit": 1,
    "anthropic_key_set": true,
    "openrouter_key_set": true,
    "openai_key_set": true
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

AI ayarlarını günceller

PATCH/api/v1/organization/ai

Yalnız gönderilen alanlar değişir. api_key yalnız yazılır, seçili sağlayıcının anahtarıdır ve kaydedilmeden önce sağlayıcıda doğrulanır: geçersizse 400, sağlayıcıya ulaşılamazsa 502. remove_key seçili sağlayıcının anahtarını siler. Sağlayıcı değişip model gönderilmezse o sağlayıcının varsayılan modeli seçilir. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
updateAiSettings · update_ai_settings
MCP aracı
updateAiSettingsdış etkili

Gövde alanları

AdTürZorunluAçıklama
providerenumhayıranthropic | openrouter | openai
modelstringhayırlen ≤ 200
monthly_limitintegerhayırval 0–1000000
api_keystringhayırlen ≤ 500
remove_keybooleanhayır

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/organization/ai" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"openrouter","model":"anthropic/claude-sonnet-5.5","monthly_limit":2000}'

Örnek yanıt (200)

JSON
{
  "data": {
    "provider": "string",
    "model": "string",
    "monthly_limit": 1,
    "anthropic_key_set": true,
    "openrouter_key_set": true,
    "openai_key_set": true
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.
  • 502Kanal ya da dış servis hatası (channel_error).

Mağaza bağlantılarını listeler

GET/api/v1/organization/stores

Şifreli anahtarlar dönmez; yalnız credentials_set ve webhook_secret_set döner. Özellik kapalıysa 409 feature_disabled. Yönetici yetkisi gerekir. Kapsam: organization:read.

Kapsam
organization:read
SDK metodu
listStores · list_stores
MCP aracı
listStoressalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 50); tam sayı değilse 400val 1–200, default 50
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/organization/stores?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "platform": "woocommerce",
      "store_url": "https://example.com/a.png",
      "notify_statuses": [
        "string"
      ],
      "language": "tr",
      "notify_opted_out": true,
      "wa_template": {
        "name": "Hiboty",
        "language": "tr"
      },
      "credentials_set": true,
      "webhook_secret_set": true,
      "last_error": "string",
      "last_event_at": "2026-11-06T09:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Mağaza bağlantısını kaydeder

PUT/api/v1/organization/stores/{platform}

WooCommerce için key ve secret, Shopify için token gerekir. Adres herkese açık https olmalıdır. Mağazaya gerçek bir test isteği gider; başarısızsa kaydedilmez (400). Gönderilmeyen anahtar ve ayarlar korunur, ancak adres değişirse anahtarlar yeniden gönderilmelidir. Özellik kapalıysa 409 feature_disabled. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
saveStore · save_store
MCP aracı
saveStoredış etkili

Parametreler

AdTürZorunluAçıklama
platformyolenumevetplatform kimliğiwoocommerce | shopify

Gövde alanları

AdTürZorunluAçıklama
store_urlstringevetlen ≤ 500
keystringhayır
secretstringhayır
tokenstringhayır
webhook_secretstringhayır
notify_statusesstring[]hayır
languageenumhayırtr | en
notify_opted_outbooleanhayır
wa_templateobject | nullhayır
wa_template.namestringevetlen 1–200
wa_template.languagestringevetlen 1–20

Örnek istek

curl -X PUT "https://hiboty.com/api/v1/organization/stores/woocommerce" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store_url":"https://magazam.ornek.com","key":"ck_ornekanahtar","secret":"cs_ornekgizli","notify_statuses":["completed"],"language":"tr","notify_opted_out":true}'

Örnek yanıt (200)

JSON
{
  "data": {
    "platform": "woocommerce",
    "store_url": "https://example.com/a.png",
    "notify_statuses": [
      "string"
    ],
    "language": "tr",
    "notify_opted_out": true,
    "wa_template": {
      "name": "Hiboty",
      "language": "tr"
    },
    "credentials_set": true,
    "webhook_secret_set": true,
    "last_error": "string",
    "last_event_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Mağaza bağlantısını kaldırır

DELETE/api/v1/organization/stores/{platform}

Sipariş sorgulama ve durum bildirimleri durur. Özellik kapalıysa 409 feature_disabled. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
deleteStore · delete_store
MCP aracı
deleteStoregeri alınamaz

Parametreler

AdTürZorunluAçıklama
platformyolenumevetplatform kimliğiwoocommerce | shopify

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/organization/stores/woocommerce" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "platform": "woocommerce",
    "deleted": true
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Mağaza bağlantısını sınar

POST/api/v1/organization/stores/{platform}/test

Mağazaya gerçek bir istek gider ve sonuç last_error alanına yazılır; başarısız bağlantı da 200 döner (connected false). Özellik kapalıysa 409 feature_disabled. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
testStore · test_store
MCP aracı
testStoredış etkili

Parametreler

AdTürZorunluAçıklama
platformyolenumevetplatform kimliğiwoocommerce | shopify

Örnek istek

curl -X POST "https://hiboty.com/api/v1/organization/stores/woocommerce/test" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "connected": true,
    "error": "string"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.feature_disabled
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

CRM bağlantılarını listele

GET/api/v1/integrations/crm

HubSpot ve Pipedrive bağlantıları; token dönmez, yalnız token_set döner. Kuyruktaki ve başarısız eşitleme işi sayısı da döner. Yönetici yetkisi gerekir. Kapsam: organization:read.

Kapsam
organization:read
SDK metodu
listCrmConnections · list_crm_connections
MCP aracı
listCrmConnectionssalt okunur

Örnek istek

curl -X GET "https://hiboty.com/api/v1/integrations/crm" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "platform": "hubspot",
      "name": "Hiboty",
      "status": "aktif",
      "token_set": true,
      "company_domain": "string",
      "field_mapping": {
        "tag_field": "string",
        "email_field": "string",
        "order_as_deal": true,
        "deal_stage": "string",
        "note_language": "tr"
      },
      "last_sync_at": "2026-11-06T09:00:00.000Z",
      "last_error": "string",
      "last_error_message": "string",
      "last_error_at": "2026-11-06T09:00:00.000Z",
      "pending_jobs": 1,
      "failed_jobs": 1,
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_at": "2026-11-06T09:00:00.000Z"
    }
  ]
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

CRM bağlantısını kaydet

POST/api/v1/integrations/crm

Token CRM'e salt okuma isteğiyle sınanır; başarısızsa kaydedilmez (400 crm_connection_failed). HubSpot: private app token'ı. Pipedrive: API token'ı ve company_domain (ör. sirketim.pipedrive.com). Kayıtlı bağlantıda token gönderilmezse kayıtlı token korunur. Token şifreli saklanır ve hiçbir yanıtta dönmez. Kişiler telefon ya da e-postayla eşleşip tek yönlü eşitlenir; devir ve Mini App siparişi not ya da fırsat olarak açılır. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
saveCrmConnection · save_crm_connection
MCP aracı
saveCrmConnectiondış etkili

Gövde alanları

AdTürZorunluAçıklama
platformenumevethubspot | pipedrive
tokenstringhayırHubSpot private app token'ı ya da Pipedrive API token'ılen ≤ 500
company_domainstringhayırYalnız Pipedrive: şirket alt alanılen ≤ 200
field_mappingobjecthayır
field_mapping.tag_fieldstring | nullhayırEtiketlerin yazılacağı CRM alanı (HubSpot özellik adı, Pipedrive 40 karakterlik özel alan anahtarı)
field_mapping.email_fieldstring | nullhayırDoğrulanmış e-posta yoksa kullanılacak Hiboty özel alan anahtarı
field_mapping.order_as_dealbooleanhayırMini App siparişini fırsat olarak aç (varsayılan true)
field_mapping.deal_stagestring | nullhayırFırsat aşaması: HubSpot dealstage iç kimliği, Pipedrive stage_id
field_mapping.note_languageenumhayırtr | en

Örnek istek

curl -X POST "https://hiboty.com/api/v1/integrations/crm" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"hubspot","token":"pat-eu1-…","field_mapping":{"tag_field":"hiboty_tags","order_as_deal":true}}'

Örnek yanıt (201)

JSON
{
  "data": {
    "platform": "hubspot",
    "name": "Hiboty",
    "status": "aktif",
    "token_set": true,
    "company_domain": "string",
    "field_mapping": {
      "tag_field": "string",
      "email_field": "string",
      "order_as_deal": true,
      "deal_stage": "string",
      "note_language": "tr"
    },
    "last_sync_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "last_error_message": "string",
    "last_error_at": "2026-11-06T09:00:00.000Z",
    "pending_jobs": 1,
    "failed_jobs": 1,
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).crm_connection_failed
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

CRM bağlantısını kaldır

DELETE/api/v1/integrations/crm

Eşitleme durur; CRM'deki kayıtlar silinmez. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
deleteCrmConnection · delete_crm_connection
MCP aracı
deleteCrmConnectiongeri alınamaz

Parametreler

AdTürZorunluAçıklama
platformsorguenumevetKaldırılacak CRMhubspot | pipedrive

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/integrations/crm?platform=hubspot" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "platform": "hubspot",
    "deleted": true
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

CRM bağlantısını sına

POST/api/v1/integrations/crm/test

Kayıtlı token'la CRM'e salt okuma isteği gider; sonuç bağlantının durumuna yazılır. Başarısız bağlantı da 200 döner (connected: false); geçersiz token bağlantıyı status: hata yapar. Yönetici yetkisi gerekir. Kapsam: organization:write.

Kapsam
organization:write
SDK metodu
testCrmConnection · test_crm_connection
MCP aracı
testCrmConnectiondış etkili

Gövde alanları

AdTürZorunluAçıklama
platformenumevethubspot | pipedrive

Örnek istek

curl -X POST "https://hiboty.com/api/v1/integrations/crm/test" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"pipedrive"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "connected": true,
    "error": "string",
    "error_message": "string",
    "connection": {
      "platform": "hubspot",
      "name": "Hiboty",
      "status": "aktif",
      "token_set": true,
      "company_domain": "string",
      "field_mapping": {
        "tag_field": "string",
        "email_field": "string",
        "order_as_deal": true,
        "deal_stage": "string",
        "note_language": "tr"
      },
      "last_sync_at": "2026-11-06T09:00:00.000Z",
      "last_error": "string",
      "last_error_message": "string",
      "last_error_at": "2026-11-06T09:00:00.000Z",
      "pending_jobs": 1,
      "failed_jobs": 1,
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_at": "2026-11-06T09:00:00.000Z"
    }
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Bağlantıları listeler

GET/api/v1/connections

Bot kanalları (Telegram, WhatsApp numarası), WhatsApp hesapları, mağaza, CRM, AI araçları, giden webhook'lar, OAuth uygulamaları ve ürün beslemeleri tek listede: tür, ad, durum, son olay ve son hata. Önce sorunlular gelir. Token, App Secret, imza sırrı ve gizli başlık hiçbir zaman dönmez; adreslerin yalnız alan adı döner. Mağaza, CRM, webhook ve OAuth satırları yalnız yöneticiye listelenir; bot erişimi kısıtlı üye yalnız erişebildiği botların bağlantılarını görür. Kapsam: organization:read.

Kapsam
organization:read
SDK metodu
listConnections · list_connections
MCP aracı
listConnectionssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
kindsorguenumhayırYalnız bu türtelegram_bot | whatsapp_number | whatsapp_account | store | crm | ai_tool | webhook | oauth_app | product_feed
statussorguenumhayırYalnız bu durumbagli | uyari | hata | kapali | bagli_degil
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 50); tam sayı değilse 400val 1–200, default 50
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/connections?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kind": "telegram_bot",
      "name": "Hiboty",
      "detail": "string",
      "status": "bagli",
      "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bot_name": "string",
      "last_event_at": "2026-11-06T09:00:00.000Z",
      "last_error": "string",
      "panel_path": "string"
    }
  ],
  "next_cursor": "string"
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.