API başvurusu

Otomasyonlar

Bu gruptaki 7 uç.

Otomasyonları listele

GET/api/v1/automations

Kapsam
read
SDK metodu
listAutomations · list_automations
MCP aracı
listAutomationssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
bot_idsorguuuidhayırYalnız bu bot
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 100); tam sayı değilse 400val 1–200, default 100
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak; eski date-time imleçleri de kabul edilir)

Örnek istek

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

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "trigger": "string",
      "active": true,
      "run_count": 1,
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_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.
  • 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.

Otomasyon oluşturur

POST/api/v1/automations

Otomasyon kapalı başlar. trigger_config ve steps verilmezse tetikleyicinin hazır başlangıcı kullanılır; verilenler panelle aynı kurallarla doğrulanır (400 automation_invalid). Webhook adımının adresi herkese açık https olmalıdır. Yönetici yetkisi gerekir. Kapsam: automations:write.

Kapsam
automations:write
SDK metodu
createAutomation · create_automation
MCP aracı
createAutomation

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
bot_iduuidevet
namestringevetlen 2–60
triggerenumevetyeni_kisi | anahtar_kelime | etiket_eklendi | sessiz | miniapp_gonderim
trigger_configobjecthayır
stepsobject[]hayır

Örnek istek

curl -X POST "https://hiboty.com/api/v1/automations" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"bot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Fiyat sorusu","trigger":"anahtar_kelime","trigger_config":{"kelimeler":["fiyat"],"eslesme":"icerir","aiBastir":true,"tekrarGun":0},"steps":[{"tur":"mesaj","metin":"Fiyat listemizi hemen paylaşıyoruz."},{"tur":"devret"}]}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "trigger": "yeni_kisi",
    "trigger_config": {},
    "steps": [
      {}
    ],
    "active": true,
    "run_count": 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).automation_invalid
  • 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.

Otomasyon ayrıntısı

GET/api/v1/automations/{id}

Tetikleyici ayarı ve adımlarla döner. Üye rolü yalnız erişebildiği botların otomasyonlarını görür. Kapsam: automations:read.

Kapsam
automations:read
SDK metodu
getAutomation · get_automation
MCP aracı
getAutomationsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

curl -X GET "https://hiboty.com/api/v1/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "trigger": "yeni_kisi",
    "trigger_config": {},
    "steps": [
      {}
    ],
    "active": true,
    "run_count": 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.

Otomasyonu kaydeder

PUT/api/v1/automations/{id}

Ad, tetikleyici ayarı ve adımların tamamını değiştirir; tetikleyici değişmez. Geçersiz yapılandırma 400 automation_invalid döner. Açma ve kapatma PATCH ile yapılır. Yönetici yetkisi gerekir. Kapsam: automations:write.

Kapsam
automations:write
SDK metodu
saveAutomation · save_automation
MCP aracı
saveAutomation

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Gövde alanları

AdTürZorunluAçıklama
namestringevetlen 2–60
trigger_configobjectevet
stepsobject[]evet

Örnek istek

curl -X PUT "https://hiboty.com/api/v1/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Fiyat sorusu","trigger_config":{"kelimeler":["fiyat"],"eslesme":"icerir","aiBastir":true,"tekrarGun":0},"steps":[{"tur":"mesaj","metin":"Fiyat listemizi hemen paylaşıyoruz."},{"tur":"devret"}]}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "trigger": "yeni_kisi",
    "trigger_config": {},
    "steps": [
      {}
    ],
    "active": true,
    "run_count": 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).automation_invalid
  • 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.

Otomasyonu etkinleştir ya da durdur

PATCH/api/v1/automations/{id}

Etkinleştirmede panelle aynı doğrulama yapılır; durdurmada süren çalıştırmalar da durur. Kapsam: write.

Kapsam
write
SDK metodu
updateAutomation · update_automation
MCP aracı
updateAutomationgeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetOtomasyon kimliği

Gövde alanları

AdTürZorunluAçıklama
activebooleanevet

Örnek istek

curl -X PATCH "https://hiboty.com/api/v1/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":true}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "trigger": "string",
    "active": true,
    "run_count": 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.

Otomasyonu siler

DELETE/api/v1/automations/{id}

Otomasyon ve çalıştırma geçmişi geri alınamaz biçimde silinir. Yönetici yetkisi gerekir. Kapsam: automations:write.

Kapsam
automations:write
SDK metodu
deleteAutomation · delete_automation
MCP aracı
deleteAutomationgeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "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.

Otomasyonun çalıştırmalarını listeler

GET/api/v1/automations/{id}/runs

En yeni önce: durum, adım, hata, adım günlüğü ve kişi kimliği. Hata ve günlük metinleri kaydedildiği dilde (Türkçe) döner. Kişinin yanıtlarını taşıyan çalıştırma bağlamı dönmez. Kapsam: automations:read.

Kapsam
automations:read
SDK metodu
listAutomationRuns · list_automation_runs
MCP aracı
listAutomationRunssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
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/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6/runs?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contact_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "running",
      "step_index": 1,
      "error": "string",
      "log": [
        {
          "step": 1,
          "type": "string",
          "result": "string",
          "at": "string"
        }
      ],
      "next_run_at": "2026-11-06T09:00:00.000Z",
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_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.
  • 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.