REST API
Buat, atur, dan hapus formulir, baca kiriman dan kelola spam, serta kelola endpoint webhook dan pengirimannya dengan secret key.
REST API memungkinkan server Anda membuat, mengatur, menjeda, dan menghapus formulir beserta skema field-nya, membaca kiriman, memindahkannya ke dan dari spam serta menghapusnya, dan membuat, mengubah, menguji, serta memutar ulang endpoint webhook. API ini berupa JSON lewat HTTPS di https://ikiform.com/api/v1. Dokumen OpenAPI 3.1 ada di /api/v1/openapi.json.
/api/v1. Kirim ke endpoint formulir dengan secret key; lihat Dari server.Bekerja dengan agen AI seperti Claude Code atau Cursor? Hubungkan server MCP sebagai gantinya: server ini menyediakan aksi yang sama sebagai tool, dengan key dan scope yang sama.
Kunci API
Buat key di dashboard pada API keys. Satu key milik satu workspace dan hanya bisa melihat workspace itu. Key lengkap hanya ditampilkan sekali; Ikiform hanya menyimpan hash-nya.
| Jenis | Awalan | Gunakan |
|---|---|---|
| Secret | ik_sk_ | Untuk server. Memanggil REST API dengan scope yang Anda pilih, dan bisa membuat kiriman. |
| Publishable | ik_pub_ | Untuk browser. Hanya bisa mengirim formulir, dan hanya dari domain yang Anda cantumkan di key. |
Scope
| Scope | Memberi akses |
|---|---|
forms:read | GET /forms, GET /forms/:formId |
forms:write | POST /forms, PATCH dan DELETE /forms/:formId, PUT dan DELETE /forms/:formId/fields |
submissions:read | GET /submissions, GET /submissions/:id |
submissions:write | DELETE /submissions/:id, POST /submissions/:id/spam dan /not-spam, serta mengirim ke /f/:formId |
webhooks:read | GET /webhooks, GET /webhooks/:endpointId dan /deliveries |
webhooks:write | POST /webhooks dan PATCH /webhooks/:endpointId (dengan submissions:read), DELETE /webhooks/:endpointId, dan POST ke /roll-secret, /test, dan /replay |
Key mempertahankan scope saat dibuat. Key yang sudah ada tidak mendapat forms:write, webhooks:read, atau webhooks:write; buat key baru dengan scope tersebut.
Autentikasi
Kirim secret key sebagai Bearer token. API ini hanya untuk server ke server: tidak mengirim header CORS dan menjawab preflight browser dengan 405, jadi secret key tidak pernah bisa dipakai dari halaman web.
curl https://ikiform.com/api/v1/forms \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"- Key yang tidak ada, salah format, tidak dikenal, dicabut, atau kedaluwarsa mendapat
401 unauthorizeddenganWWW-Authenticate: Bearer. - Publishable key mendapat
403 forbidden(Publishable keys can only submit forms.). Key tanpa scope yang dibutuhkan mendapat403 forbiddendengan nama scope disebut di pesannya. - Respons dikirim dengan
Cache-Control: no-store.
Contoh SDK di bawah memakai satu client yang sama:
import { createClient } from "@ikiform/sdk";
const ikiform = createClient({ apiKey: process.env.IKIFORM_SECRET_KEY! });Penyusun request
curl "https://ikiform.com/api/v1/submissions?form_id=frm_xxxxxxxxxxxxxxxx&status=received&limit=50" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Jalankan ini dari server Anda. REST API menolak request dari browser, jadi halaman ini tidak pernah mengirimnya.
Endpoint
| Metode | Path | Scope | Mengembalikan |
|---|---|---|---|
GET | /me | any | Periksa API key |
GET | /forms | forms:read | Daftar formulir |
GET | /forms/:formId | forms:read | Ambil satu formulir |
POST | /forms | forms:write | Buat formulir |
PATCH | /forms/:formId | forms:write | Perbarui formulir |
PUT | /forms/:formId/fields | forms:write | Terbitkan skema field |
DELETE | /forms/:formId/fields | forms:write | Hapus skema field |
DELETE | /forms/:formId | forms:write | Hapus formulir |
GET | /submissions | submissions:read | Daftar kiriman |
GET | /submissions/:id | submissions:read | Ambil satu kiriman |
POST | /submissions/:id/spam | submissions:write | Tandai sebagai spam |
POST | /submissions/:id/not-spam | submissions:write | Tandai sebagai bukan spam |
DELETE | /submissions/:id | submissions:write | Hapus kiriman |
GET | /forms/:formId/fields | forms:read | Daftar field sebuah formulir |
GET | /forms/:formId/sample | submissions:read | Contoh event kiriman |
GET | /webhooks | webhooks:read | Daftar endpoint webhook |
POST | /webhooks | webhooks:write | Buat endpoint webhook |
GET | /webhooks/:endpointId | webhooks:read | Ambil endpoint webhook |
PATCH | /webhooks/:endpointId | webhooks:write | Perbarui endpoint webhook |
POST | /webhooks/:endpointId/roll-secret | webhooks:write | Putar signing secret |
DELETE | /webhooks/:endpointId | webhooks:write | Hapus endpoint webhook |
POST | /hooks | webhooks:write | Berlangganan REST hook |
DELETE | /hooks/:hookId | webhooks:write | Berhenti berlangganan REST hook |
GET | /webhooks/:endpointId/deliveries | webhooks:read | Daftar pengiriman |
POST | /webhooks/:endpointId/test | webhooks:write | Kirim event uji |
POST | /webhooks/:endpointId/replay | webhooks:write | Putar ulang pengiriman yang gagal |
GET | /openapi.json | Tidak ada | Dokumen OpenAPI |
GET | /health | Tidak ada | { "ok": true } |
Periksa API key
GET /me dengan scope apa pun.
- Berfungsi dengan scope apa pun. Platform otomasi memanggilnya untuk menguji koneksi dan memberinya nama sesuai workspace.
curl https://ikiform.com/api/v1/me \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Daftar formulir
GET /forms dengan scope forms:read.
- Terbaru lebih dulu. Menerima
limit(1 sampai 100, default 25) dancursor.
curl "https://ikiform.com/api/v1/forms?limit=10" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Ambil satu formulir
GET /forms/:formId dengan scope forms:read.
- Juga mengembalikan
fieldsdandefinition, yaitu skema field yang diterbitkan, ataunulljika formulir tidak punya skema dan menerima field apa pun, serta apakahnotificationsaktif.
curl https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Buat formulir
POST /forms dengan scope forms:write.
- Hanya
nameyang wajib. Kirim JSON denganContent-Type: application/json. - Kirim kiriman ke
endpointyang dikembalikan. Tambahkan input tersembunyi bernamahoneypot_fielddan biarkan kosong. - Endpoint ini juga menerima setiap pengaturan yang diterima Perbarui formulir, kecuali
status.
curl -X POST https://ikiform.com/api/v1/forms \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Waitlist", "allowed_domains": ["example.com"], "redirect_url": "https://example.com/thanks" }'Perbarui formulir
PATCH /forms/:formId dengan scope forms:write.
- Kirim hanya yang berubah.
statusadalahactiveataupaused; formulir yang dijeda menolak kiriman. Formulir yang dinonaktifkan Ikiform mengembalikan403. - Kirim
[]ataunulluntuk mengosongkanallowed_domainsatauredirect_url, dannullsebagaihoneypot_fielduntuk_gotcha. spam_checkadalahoff,ikiform(pemeriksaan manusia dari kami), ataucustom(widget Turnstile Anda, denganturnstile_site_keydanturnstile_secret). Secret disimpan terenkripsi dan tidak pernah dikembalikan;nullmenghapusnya dan mematikancustom.origin_mismatchadalahspamataurejectuntuk kiriman dari situs di luarallowed_domains.rate_limitmenerimapreset(standard,relaxed,strict, ataucustom), ditambahper_ip,window_seconds(10, 60, 600, 3600, atau 86400) danper_form_per_minuteopsional untukcustom. Pengaturan ini hanya bisa ditulis, jadi bot tidak bisa membacanya.notifications: { "enabled": false }menghentikan email kiriman baru. Penerima dipilih di dashboard.- Field yang tidak dikenal mengembalikan
400 invalid_requestdengan menyebut nama field-nya.
curl -X PATCH https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "paused", "origin_mismatch": "reject", "rate_limit": { "preset": "strict" } }'Terbitkan skema field
PUT /forms/:formId/fields dengan scope forms:write.
- Body-nya adalah definisi formulir:
version1, sebuahtitle, dan hingga 100fields, dengan format yang sama seperti Field. Ukurannya bisa hingga 256 KB. - Sejak saat itu, kiriman divalidasi terhadapnya dan kiriman yang tidak cocok ditolak dengan
422. Definisi yang bermasalah mengembalikan422 validation_failed, danerror.fieldsmencantumkannya per path, sepertifields.0.type.
curl -X PUT https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/fields \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "version": 1, "title": "Contact", "fields": [{ "id": "email", "type": "email", "label": "Email", "required": true }, { "id": "message", "type": "textarea", "label": "Message" }] }'Hapus skema field
DELETE /forms/:formId/fields dengan scope forms:write.
- Formulir kembali menerima field apa pun.
curl -X DELETE https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/fields \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Hapus formulir
DELETE /forms/:formId dengan scope forms:write.
- Endpoint langsung berhenti menerima kiriman, dan formulir hilang dari daftar. Menghapus lagi mengembalikan
404.
curl -X DELETE https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Daftar kiriman
GET /submissions dengan scope submissions:read.
| Parameter | Nilai | Default |
|---|---|---|
form_id | ID formulir | Semua formulir di workspace |
status | received atau spam | Keduanya |
limit | 1 sampai 100 | 25 |
cursor | next_cursor dari halaman sebelumnya | Halaman pertama |
- Terbaru lebih dulu.
form_iddari workspace lain mengembalikan daftar kosong alih-alih error, jadi ID tidak bisa ditebak-tebak.
curl "https://ikiform.com/api/v1/submissions?form_id=frm_xxxxxxxxxxxxxxxx&status=received&limit=50" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Ambil satu kiriman
GET /submissions/:id dengan scope submissions:read.
curl https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Tandai sebagai spam
POST /submissions/:id/spam dengan scope submissions:write.
- Memindahkan kiriman yang diterima ke spam, menurunkan
submission_countformulir, membatalkan pengirimansubmission.createdyang tertunda, dan mengirimsubmission.updatedke endpoint yang berlangganan. - Memanggilnya pada kiriman yang sudah spam mengembalikannya tanpa perubahan.
curl -X POST https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3/spam \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Tandai sebagai bukan spam
POST /submissions/:id/not-spam dengan scope submissions:write.
- Memindahkannya kembali ke diterima, menghapus skor dan alasan spam-nya, dan mengirim
submission.updatedke endpoint yang berlangganan, sertasubmission.createdke endpoint berlangganan yang belum pernah menerimanya. - Memanggilnya pada kiriman yang diterima mengembalikannya tanpa perubahan.
curl -X POST https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3/not-spam \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Hapus kiriman
DELETE /submissions/:id dengan scope submissions:write.
- Menghapus kiriman dan pengiriman webhook-nya secara permanen, lalu mengirim
submission.deletedke endpoint yang berlangganan. Tidak bisa dibatalkan. Menghapus lagi mengembalikan404.
curl -X DELETE https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Daftar field sebuah formulir
GET /forms/:formId/fields dengan scope forms:read.
- Mendaftar field yang bisa dibawa sebuah kiriman, untuk pemetaan di Zapier, Make, atau n8n.
keyadalah nama yang dimiliki nilai tersebut difields. sourcebernilaidefinitionjika formulir memiliki field yang dipublikasikan. Jika tidak, daftar dibuat dari key 25 kiriman terbaru, tanpa key_yang dicadangkan.
curl https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/fields \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Contoh event kiriman
GET /forms/:formId/sample dengan scope submissions:read.
- Mengembalikan hingga 3 kiriman yang baru diterima, persis dalam body yang dibawa webhook
submission.created, sehingga sebuah tool bisa menampilkan data asli saat Anda menyiapkannya. - Formulir tanpa kiriman mendapat satu contoh yang dibuat dari field-nya, dengan
submission_iddiatur kesub_example.
curl https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/sample \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Daftar endpoint webhook
GET /webhooks dengan scope webhooks:read.
- Mengembalikan setiap endpoint di workspace dalam satu halaman.
- Signing secret dan nilai header kustom tidak pernah dikembalikan.
header_namesmencantumkan header kustom yang dibawa setiap pengiriman.
curl https://ikiform.com/api/v1/webhooks \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Buat endpoint webhook
POST /webhooks dengan scope webhooks:write.
urlmengikuti aturan URL endpoint. Hilangkanform_iduntuk semua formulir.event_typessecara defaultsubmission.created.headersadalah daftar{ name, value }, disimpan terenkripsi; lihat Header kustom.secrethanya dikembalikan di sini, jadi simpan sekarang. Jika melewati batas endpoint paket Anda, Anda mendapat402 plan_required.- Membuat atau mengubah endpoint juga membutuhkan
submissions:read, karena endpoint menerima data kiriman.
curl -X POST https://ikiform.com/api/v1/webhooks \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://example.com/webhooks/ikiform", "form_id": "frm_xxxxxxxxxxxxxxxx", "headers": [{ "name": "Authorization", "value": "Bearer your-token" }] }'Ambil endpoint webhook
GET /webhooks/:endpointId dengan scope webhooks:read.
curl https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Perbarui endpoint webhook
PATCH /webhooks/:endpointId dengan scope webhooks:write.
- Kirim hanya yang berubah:
url,form_id,description,event_types,headers, ataustatus. status: "disabled"menghentikan pengiriman dan"active"melanjutkannya. Melanjutkan tidak mengirim yang terlewat: putar ulang.headersmenggantikan daftar yang tersimpan;"value": nullmempertahankan nilai yang tersimpan. Saaturlberubah, kirim ulang setiap nilai agar token tidak pernah sampai ke host baru secara tidak sengaja.
curl -X PATCH https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "disabled" }'Putar signing secret
POST /webhooks/:endpointId/roll-secret dengan scope webhooks:write.
- Mengembalikan signing secret baru satu kali. Yang lama tetap berfungsi selama 24 jam, sehingga Anda bisa memperbarui server tanpa kehilangan pengiriman.
curl -X POST https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/roll-secret \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Hapus endpoint webhook
DELETE /webhooks/:endpointId dengan scope webhooks:write.
- Menghapus endpoint beserta riwayat pengirimannya. Pengiriman yang tertunda ke endpoint ini dibatalkan.
curl -X DELETE https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Berlangganan REST hook
POST /hooks dengan scope webhooks:write.
- Membuat endpoint webhook untuk platform otomasi. Menerima field yang sama dengan Buat endpoint webhook, ditambah
managed_by:zapier,make,n8n, atauautomation(default). - Ini endpoint biasa: dihitung dalam batas endpoint paket Anda, tampil di dashboard, dan ditandatangani. Saat penerimanya menjawab
410 Gone, endpoint dihapus tanpa email yang biasa, karena platform telah menonaktifkannya. - Juga memerlukan
submissions:read, karena hook menerima data kiriman.
curl -X POST https://ikiform.com/api/v1/hooks \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://hooks.zapier.com/hooks/standard/123/abc", "form_id": "frm_xxxxxxxxxxxxxxxx", "managed_by": "zapier" }'Berhenti berlangganan REST hook
DELETE /hooks/:hookId dengan scope webhooks:write.
- Menghapus hook beserta riwayat pengirimannya, seperti Hapus endpoint webhook.
curl -X DELETE https://ikiform.com/api/v1/hooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Daftar pengiriman
GET /webhooks/:endpointId/deliveries dengan scope webhooks:read.
- Terbaru lebih dulu.
statusadalahsucceeded,pending, ataufailed;failedmencakup pengiriman yang dibatalkan. Menerimalimitdancursorseperti daftar lainnya. last_status_codedanlast_errorberasal dari percobaan terbaru.
curl "https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/deliveries?status=failed&limit=50" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Kirim event uji
POST /webhooks/:endpointId/test dengan scope webhooks:write.
- Mengantrekan event
endpoint.testdan mengembalikan pengirimannya. Daftarkan pengiriman untuk melihat bagaimana server Anda menjawab. - Endpoint yang dinonaktifkan mengembalikan
409 conflict. Aktifkan lebih dulu.
curl -X POST https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/test \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Putar ulang pengiriman yang gagal
POST /webhooks/:endpointId/replay dengan scope webhooks:write.
windowadalah24h,3d, atau7d. Setiap pengiriman yang dibuat dalam rentang itu dan gagal atau dibatalkan dikirim ulang dalam sekitar satu menit, hingga 1.000 per panggilan.- Jika
morebernilaitrue, panggil lagi untuk memutar ulang sisanya. - Endpoint yang dinonaktifkan mengembalikan
409 conflict. Event uji tidak pernah diputar ulang. Lihat Memutar ulang pengiriman yang gagal.
curl -X POST https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/replay \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "window": "24h" }'Objek
Objek berupa JSON snake_case dengan field object. Timestamp memakai ISO 8601 dalam UTC dengan milidetik. ID kiriman, endpoint, dan pengiriman berurutan menurut waktu (sub_, whk_, dan dlv_ ditambah 26 karakter); ID formulir acak (frm_ ditambah 16 karakter).
| Field formulir | Deskripsi |
|---|---|
status | active, paused, atau disabled |
submission_count | Kiriman yang diterima, bukan spam |
endpoint | URL tujuan pengiriman kiriman |
honeypot_field | Field tersembunyi yang diisi bot. Biarkan kosong di formulir Anda |
allowed_domains | Situs yang boleh mengirim, termasuk subdomain. Kosong berarti semua situs diizinkan |
redirect_url | Tujuan browser setelah kiriman HTML biasa, atau null untuk halaman terima kasih Ikiform |
spam_check | off, ikiform, atau custom, dengan turnstile_site_key dan turnstile_secret_set untuk custom |
origin_mismatch | spam atau reject: apa yang terjadi pada kiriman dari situs di luar allowed_domains |
fields, definition, notifications | Hanya saat mengambil, membuat, atau memperbarui satu formulir. Skema field, atau null jika tidak ada, serta apakah kiriman baru dikirim lewat email |
| Field endpoint webhook | Deskripsi |
|---|---|
form_id | Satu formulir yang eventnya diterima, atau null untuk semua formulir |
status | active atau disabled, dengan disabled_reason saat dinonaktifkan |
event_types | Event yang dilanggan |
header_names | Header kustom yang dikirim bersama setiap pengiriman. Nilainya tidak pernah dikembalikan |
failing_since, consecutive_failures, circuit_open_until | Pelacakan kegagalan. Pengiriman dijeda sampai circuit_open_until setelah gagal berulang kali |
| Field pengiriman | Deskripsi |
|---|---|
status | pending, succeeded, failed or cancelled |
attempt_count | Jumlah percobaan sejauh ini |
last_status_code, last_error | Kode status server Anda, atau errornya, dari percobaan terbaru |
next_attempt_at | Kapan pengiriman tertunda dicoba berikutnya |
| Field kiriman | Deskripsi |
|---|---|
status | received atau spam |
fields | Nilai yang disimpan |
meta | user_agent, origin, referrer, country, subject, reply_to. Setiap key selalu ada dan nilai apa pun bisa null. Hash IP tidak pernah dikembalikan |
spam.score, spam.reasons | Skor dan alasan spam, seperti honeypot atau origin_mismatch |
Paginasi
Daftar diurutkan dari yang terbaru dan memakai cursor opaque.
- Kirim request tanpa cursor.
- Jika
has_morebernilai true, kirimnext_cursorsebagaicursordengan filter yang sama. - Berhenti saat
next_cursorbernilainull.
Halaman tetap stabil saat kiriman baru masuk: kiriman baru muncul di halaman pertama, tidak pernah sebagai duplikat di halaman berikutnya. Jangan membuat atau mengurai cursor sendiri; cursor yang tidak valid mengembalikan 400 invalid_request.
for await (const submission of ikiform.submissions.iterate({ formId: "frm_xxxxxxxxxxxxxxxx" })) {
console.log(submission.id, submission.fields);
}Error
Error memakai envelope yang sama dengan kiriman formulir. Setiap respons punya header X-Request-Id, yang diulang oleh error sebagai request_id.
{
"ok": false,
"error": { "code": "forbidden", "message": "This API key is missing the forms:read scope." },
"request_id": "req_01k7v2c9t3e8m5q4x6z0a1b2c3"
}| Status | Kode | Kapan |
|---|---|---|
| 400 | invalid_request | Parameter query atau field body tidak valid; pesan menyebutkan namanya, dan error.fields memetakan field body ke pesannya |
| 400 | invalid_body | Body bukan objek JSON |
| 401 | unauthorized | Key tidak ada atau tidak valid |
| 402 | plan_required | Membuat endpoint webhook melebihi jumlah yang disertakan paket Anda |
| 403 | forbidden | Publishable key, scope yang kurang, atau melanjutkan formulir yang dinonaktifkan Ikiform |
| 404 | not_found | Route atau ID tidak dikenal, atau ID di workspace lain, sama persis seperti yang tidak ada |
| 405 | method_not_allowed | Preflight browser |
| 409 | conflict | Menguji atau memutar ulang endpoint webhook yang dinonaktifkan |
| 413 | payload_too_large | Body lebih dari 16 KB, atau 256 KB untuk skema field |
| 415 | unsupported_media_type | Body tidak dikirim sebagai application/json |
| 422 | validation_failed | Skema field bermasalah; error.fields mencantumkannya per path |
| 429 | rate_limited | Melewati rate limit per key |
| 500 | server_error | Ada yang gagal di pihak kami; sertakan request_id |
Rate limit
Setiap key bisa membuat 100 request per 60 detik. Jika melewati batas, API mengembalikan 429 rate_limited dengan header Retry-After dalam detik. SDK mengeksposnya sebagai error.retryAfter.
Hanya di dashboard
Key API, anggota dan undangan, penerima notifikasi, serta penagihan hanya dikelola di dashboard. Key yang bocor tidak bisa membuat key lain, mengundang seseorang ke workspace Anda, mengirim email ke alamat baru, atau menghabiskan uang.