v1.0.*

Documentation

Falcosend is an edge-optimized form backend. Collect and route submissions without a dedicated server.

Base URL https://api.falcosend.ellypad.com/v1/

Installation

Install the SDK with npm, pnpm, yarn, e.t.c

pnpm add falcosend-sdk

Construct a FalcoSend instance using your unique key from the dashboard.

import { FalcoSend } from 'falcosend-sdk';

const sdk = new FalcoSend({
  submissionKey: 'YOUR_KEY'
});

Param	Type	Description
`submissionKey`	`string`	Required submission key.
`url`	`string`	Optional API gateway override.

Call the submit method of the FalcoSend instance with the form name and data.

await sdk.submit({
  form_name: 'Form Name', // 'Contact Form', 'Survey Form', ...
  data: { email: 'user@example.com', ... }
});

Param	Type	Description
`form_name`	`string`	Required form identifier.
`data`	`object`	Form data in form of object, hashmap or string.

Sends form data to the global edge network. Returns a Promise.

The SDK is TypeScript native and exports all necessary interface types for your project.