PluginOnboardingStep

Defined in: plugin.ts:291

Properties

actionLabel?

optional actionLabel?: string

Defined in: plugin.ts:310

---

desc?

optional desc?: string

Defined in: plugin.ts:307

---

field?

optional field?: object

Defined in: plugin.ts:311

key

key: string

placeholder?

optional placeholder?: string

secret?

optional secret?: boolean

---

kind

kind: "link" | "field" | "verify" | "instructions" | "copy" | "await-event"

Defined in: plugin.ts:305

Step kinds:

• field collect a plugin setting (API key / secret)
• verify run a connection test
• link open an external URL (informational)
• instructions render a markdown checklist (markdown) of provider-side steps; the user marks it done manually
• copy show a fully-resolved value with a copy button (platform-generated for trigger plugins: the inbound URL)
• await-event poll the connection status endpoint and flip done when the provider’s handshake / first event actually arrives (platform-generated for trigger plugins)

---

markdown?

optional markdown?: string

Defined in: plugin.ts:317

Markdown body for instructions steps.

---

optional?

optional optional?: boolean

Defined in: plugin.ts:308

---

title

title: string

Defined in: plugin.ts:306

---

url?

optional url?: string

Defined in: plugin.ts:309