Otomasyonlar API

Olan bitene tepki veren ya da zamanlanmış çalışan, işi sizin yerinize yapan otomasyonlar.

Modül kodu workflows · 10 işlem · 3 veri modeli · 10 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: workflows (hepsi), workflows:read (yalnız okuma) ya da workflows:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

workflows.cancel_wait

Bekleyen iş akışı çalıştırmasını iptal et — Bekleyen bir tuval çalıştırmasını durdurur; çalışmış bloklar yapılmış kalır.

Gereken izin workflows:write · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/workflows.cancel_wait

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.wait_cancelled

Neye yazar: canvas_wait (update) — Marks the wait for cancelling

curl -X POST https://app.getera.io/api/v1/canvas_waits/CANVAS_WAIT_ID/actions/cancel_wait \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "workflows.wait_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.canvasWaits.cancelWait("CANVAS_WAIT_ID")

era canvas_waits cancel_wait CANVAS_WAIT_ID

{
  "name": "era__workflows__cancel_wait",
  "arguments": {
    "waitId": "CANVAS_WAIT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_finished · 429 çok sık istek

workflows.decide_wait

Bekleyen iş akışını onayla veya reddet — Bir Era onayını yanıtlar. Görevler ekranında görevini tamamlamak da aynı şeyi yapar.

Gereken izin workflows:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/workflows.decide_wait

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.wait_decided

Neye yazar: canvas_wait (update) — Records the decision

curl -X POST https://app.getera.io/api/v1/canvas_waits/CANVAS_WAIT_ID/actions/decide_wait \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"approve":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "workflows.wait_decided"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.canvasWaits.decideWait("CANVAS_WAIT_ID", {
  approve: true
})

era canvas_waits decide_wait CANVAS_WAIT_ID \
  --approve true

{
  "name": "era__workflows__decide_wait",
  "arguments": {
    "waitId": "CANVAS_WAIT_ID",
    "approve": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, not_waiting_for_approval · 429 çok sık istek

workflows.draft

İş akışı taslağı hazırla — Bir iş akışının tamamını — tetikleyici, koşullar ve adımlar — denetler ve biri inceleyip yayına alsın diye tuval olarak çizer.

Gereken izin workflows:manage · veriyi değiştirir

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.drafted

curl -X POST https://app.getera.io/api/v1/actions/workflows.draft \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "workflows.drafted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("workflows.draft", {
  name: "Name"
})

era workflows draft \
  --name "Name"

{
  "name": "era__workflows__draft",
  "arguments": {
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 empty_name, unknown_event, bad_trigger, bad_schedule, bad_condition, bad_step, unknown_action · 429 çok sık istek

workflows.install_template

Şablondan iş akışı başlat — Şablonu sizin için doldurur ve tuval olarak çizer; incelemeye ve yayına almaya hazır.

Gereken izin workflows:manage · veriyi değiştirir

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.template_used

curl -X POST https://app.getera.io/api/v1/actions/workflows.install_template \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"code":"Template"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "workflows.template_used"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("workflows.install_template", {
  code: "Template"
})

era workflows install_template \
  --code "Template"

{
  "name": "era__workflows__install_template",
  "arguments": {
    "code": "Template"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 unknown_template, template_needs_module · 429 çok sık istek

workflows.note_undo

İş akışı çalıştırmasının geri alınmasını kaydet — Bir çalıştırmanın hangi Era aksiyonlarının tersleriyle geri alındığını, hangilerinin reddettiğini kaydeder.

Gereken izin workflows:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/workflows.note_undo

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.run_undone

Neye yazar: canvas_run_note (upsert) — Records the undo

curl -X POST https://app.getera.io/api/v1/canvas_run_notes/actions/note_undo \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"canvasId":"Canvas workflow","executionId":"Canvas execution","status":"done","steps":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "workflows.run_undone"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.canvasRunNotes.noteUndo({
  canvasId: "Canvas workflow",
  executionId: "Canvas execution",
  status: "done",
  steps: {}
})

era canvas_run_notes note_undo --data '{"canvasId":"Canvas workflow","executionId":"Canvas execution","status":"done","steps":{}}'

{
  "name": "era__workflows__note_undo",
  "arguments": {
    "canvasId": "Canvas workflow",
    "executionId": "Canvas execution",
    "status": "done",
    "steps": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 bad_canvas, already_undone · 429 çok sık istek

workflows.park_canvas

İş akışı çalıştırmasını beklemeye al — Otomatik: Era bekleme / onay bloğu tuval çalıştırmasını zamanına, yanıtına ya da süresinin dolmasına kadar bekletir.

Gereken izin workflows:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/workflows.park_canvas

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.canvas_parked

Neye yazar: canvas_wait (upsert) — Records the parked execution

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 bad_canvas, bad_wait · 429 çok sık istek

workflows.record_step_key

Adımın tekrar anahtarını hatırla — Otomatik: tekrar anahtarı olan bir Era bloğu başarılı oldu; o anahtar için bir daha çalışmaz.

Gereken izin workflows:write · veriyi değiştirir

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.step_key_recorded

Neye yazar: canvas_step_key (insert) — Remembers the key

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 bad_canvas, already_done · 429 çok sık istek

workflows.report_run_failed

Başarısız iş akışı çalıştırmasını bildir — Otomatik: başarısız bir tuval çalıştırmasını bir kez, sahibine giden workflows.run_failed olayına çevirir.

Gereken izin workflows:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/workflows.report_run_failed

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.run_failed

Neye yazar: canvas_run_note (upsert) — Marks the failure reported

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 bad_canvas, already_reported · 429 çok sık istek

workflows.subscribe_canvas

Modül olayında iş akışı başlat — Olay olduğunda tuval kendiliğinden başlar — Era olay tetikleyicisi olan bir tuval yayına alındığında çağrılır.

Gereken izin workflows:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/workflows.subscribe_canvas

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.canvas_subscribed

Neye yazar: canvas_trigger (upsert) — Creates or updates the canvas subscription

curl -X POST https://app.getera.io/api/v1/canvas_triggers/actions/subscribe_canvas \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"canvasId":"Canvas workflow","eventPattern":"When this happens"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "workflows.canvas_subscribed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.canvasTriggers.subscribeCanvas({
  canvasId: "Canvas workflow",
  eventPattern: "When this happens"
})

era canvas_triggers subscribe_canvas \
  --canvas-id "Canvas workflow" \
  --event-pattern "When this happens"

{
  "name": "era__workflows__subscribe_canvas",
  "arguments": {
    "canvasId": "Canvas workflow",
    "eventPattern": "When this happens"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 bad_canvas, unknown_event, bad_trigger · 429 çok sık istek

workflows.unsubscribe_canvas

İş akışının olay dinlemesini durdur — Tuval aboneliğini kaldırır; tuval artık modül olaylarında başlamaz.

Gereken izin workflows:manage · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/workflows.unsubscribe_canvas

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: workflows.canvas_unsubscribed

Neye yazar: canvas_trigger (delete) — Removes the subscription

curl -X POST https://app.getera.io/api/v1/canvas_triggers/actions/unsubscribe_canvas \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"canvasId":"Canvas workflow"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "workflows.canvas_unsubscribed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.canvasTriggers.unsubscribeCanvas({
  canvasId: "Canvas workflow"
})

era canvas_triggers unsubscribe_canvas \
  --canvas-id "Canvas workflow"

{
  "name": "era__workflows__unsubscribe_canvas",
  "arguments": {
    "canvasId": "Canvas workflow"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde workflows:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_subscribed · 429 çok sık istek

Veri modelleri

CanvasRunNote

Tablo canvas_run_note · Kaynak canvas_run_notes

• GET /api/v1/canvas_run_notes
• GET /api/v1/canvas_run_notes/{id}

Birincil anahtar: id

Denetimler:

• CHECK (((undo_status IS NULL) OR (undo_status = ANY (ARRAY['done'::text, 'partial'::text]))))

CanvasTrigger

Tablo canvas_trigger · Kaynak canvas_triggers

• GET /api/v1/canvas_triggers
• GET /api/v1/canvas_triggers/{id}

Birincil anahtar: id

Denetimler:

• CHECK ((canvas_id ~ '^[A-Za-z0-9_-]{1,128}$'::text))
• CHECK (((event_pattern = '*'::text) OR (event_pattern ~ '^[a-z][a-z0-9_]*\.([a-z][a-z0-9_]*\|\*)$'::text)))

CanvasWait

Tablo canvas_wait · Kaynak canvas_waits

• GET /api/v1/canvas_waits
• GET /api/v1/canvas_waits/{id}

Birincil anahtar: id

Denetimler:

• CHECK ((canvas_id ~ '^[A-Za-z0-9_-]{1,128}$'::text))
• CHECK (((decision IS NULL) OR (decision = ANY (ARRAY['approved'::text, 'rejected'::text]))))

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.