Skip to main content

APISetup

openmolt

openmolt / APISetup

Interface: APISetup

Defined in: types/index.ts:49

Generic API setup used to configure HTTP tool calls for an integration.

Properties​

baseUrl​

baseUrl: string

Defined in: types/index.ts:51

Base URL prepended to all endpoint paths. Supports Liquid templates with config.* variables.

headers?​

optional headers: Record<string, string>

Defined in: types/index.ts:53

Default headers merged into every request. Supports Liquid templates.

requestFormat?​

optional requestFormat: "json" | "url-encoded" | "form-data" | "text"

Defined in: types/index.ts:61

Body serialisation format for outgoing requests.

  • json: application/json (default)
  • url-encoded: application/x-www-form-urlencoded (Stripe, Twilio, etc.)
  • form-data: multipart/form-data (file uploads)
  • text: text/plain

responseFormat?​

optional responseFormat: "json" | "text" | "xml"

Defined in: types/index.ts:63

Expected format of API responses.