Skip to main content
Bir üye, otomasyonun trigger_event olayı kendisine gerçekleştiğinde kaydolur; örneğin payment.succeeded. Bir üyeyi POST /automations/{id}/trigger ile de kaydedebilirsiniz. Bir wait adımı üyeyi belirli bir süre bekletir. Bir email veya message adımı, üyenin verilerini API üzerinden okuyan bir TSX modülü olan source_code kodunu çalıştırır. Modül gönderip göndermeyeceğine ve ne söyleyeceğine karar verir. Adımlar sürümlendirilir. Taslak sürümü düzenlersiniz. POST /automations/{id}/publish onu yeni üyelerin başladığı sürüm yapar, ardından bir sonraki taslağa kopyalar. Her yayınlama, otomasyonda zaten bulunan üyeleri yeni sürüme taşır. Otomasyon oluşturmak, yayınlamak ve tetiklemek ve durumları dahil olmak üzere güncellemek için Automations API’yi kullanın. Adımları ve üyeleri için Automation steps ve Automation enrollments API’lerini kullanın.

Uç noktalar

Özellikler

string
gerekli
ato_ önekli otomasyon kimliği.
string
gerekli
Otomasyonun ait olduğu hesabın biz_ önekli kimliği.
integer
gerekli
Şu anda otomasyonda bulunan üyeler.
string
gerekli
Otomasyonun oluşturulduğu zaman, ISO 8601 zaman damgası olarak.
object
gerekli
Otomasyonu kimin oluşturduğu.

Özellikler

string
gerekli
user_, biz_ veya app_ önekli kullanıcı, hesap veya uygulama kimliği.
string
gerekli
İşlemi kimin yaptığı: bir user, API anahtarlarından biri aracılığıyla bir account veya bir app.Kullanılabilir seçenekler: user, account, app
integer
gerekli
Adım düzenlemelerinin değiştirdiği sürüm. Her zaman published_version artı bir veya ilk yayınlamadan önce 1.
boolean
gerekli
Taslağın POST /automations/\{id}/publish tarafından yayınlanacak düzenlemeleri olup olmadığı. İlk yayınlamadan önce her zaman true.
string
gerekli
Otomasyonun panoda gösterilen adı. En fazla 255 karakter.
string | null
gerekli
Otomasyonun en son yayınlandığı zaman, ISO 8601 zaman damgası olarak. İlk yayınlamaya kadar null.
object | null
gerekli
Otomasyonu en son kimin yayınladığı. İlk yayınlamaya kadar null.

Özellikler

string
gerekli
user_, biz_ veya app_ önekli kullanıcı, hesap veya uygulama kimliği.
string
gerekli
İşlemi kimin yaptığı: bir user, API anahtarlarından biri aracılığıyla bir account veya bir app.Kullanılabilir seçenekler: user, account, app
integer | null
gerekli
Yeni üyelerin başladığı sürüm. Otomasyon ilk kez yayınlanana kadar null.
string[]
gerekli
Otomasyonun, adımlarının kodunun ortam değişkenleri olarak okuduğu gizli anahtarlarının adları. Değerleri asla döndürülmez.
string
gerekli
active üyeleri kaydeder ve adımlarını çalıştırır. closed yeni kimseyi kaydetmez ve içindeki üyeler tamamlar. stopped kimseyi kaydetmez ve üyelerinin kayıtları sona ermiştir. Yeni bir otomasyon, ilk yayınlaması onu active yapana kadar stopped durumundadır.Kullanılabilir seçenekler: active, closed, stopped
integer
gerekli
Sona erenler dahil, üyelerin otomasyona kaç kez kaydolduğu.
string | null
gerekli
İlgili olduğu üyeyi kaydeden webhook olayı; örneğin payment.succeeded. Yalnızca POST /automations/\{id}/trigger ile kayıt yapılan bir otomasyon için null. Otomasyon yayınlandıktan sonra sabitlenir.Kullanılabilir seçenekler: payment.succeeded, payment.failed, membership.activated, membership.trial_ending_soon, member.created, invoice.created, invoice.paid, invoice.past_due, refund.created, dispute.created, resolution_center_case.created, resolution_center_case.decided, course_lesson_interaction.completed
string
gerekli
Otomasyonun en son güncellendiği zaman, ISO 8601 zaman damgası olarak.
Automation