Skip to main content
This skill teaches your coding agent how to use the @inkbox/sdk TypeScript package. Once installed, the agent automatically knows the correct imports, initialization patterns, and method signatures for the entire SDK surface — identities, email, phone, SMS/MMS, vault, contacts, notes, contact rules, TOTP, tunnels, whoami, and webhooks. View the source →

What your agent learns

Directional policies and notices

Use SDK 0.7.14 or later for Slack rules through client.slack.contactRules, paginated contact import, and slackFilterMode with its inbound/outbound overrides. Rule writes, defaults and import require an organization admin key; claimed agent keys can read their own rules. Import never grants messaging or Companion access. See Slack contact rules and contact import. Use SDK 0.7.3 or later for direction on mail/phone/iMessage rule create, update, and list calls. applyTo on an update changes one covered side’s action atomically; ordinary direction changes coverage. Identity updates accept mailInboundFilterMode, mailOutboundFilterMode, phoneInboundFilterMode, and phoneOutboundFilterMode. Contact access accepts inboundContactable and outboundContactable; legacy contactable reads mean outbound while legacy writes still set both sides. See contact access. new Inkbox({ apiKey, onResponse }) observes optional metadata. withResponseMetadata(callback) returns an additive APIResponse with the original value in data.

Install

bash

Prerequisites

  • Node.js ≥ 22 (declared in @inkbox/sdk engines.node)
  • @inkbox/sdk installed in your project (npm install @inkbox/sdk)
  • An Inkbox API key from the Console

Message request retries

Send calls generate keys and preserve them during bounded retries. Application code can supply idempotencyKey across separate calls. Reuse identical input and read the returned message ID for current delivery status. See retry behavior.