@linkpane/sdk
v1.0.1
Published
Aggregate SDK for Linkpane integrations
Readme
@linkpane/sdk
Linkpane Mailer is a hosted form and email capture service by Haqqman. It allows you to collect form submissions and newsletter signups without building, deploying, or maintaining your own backend.
Linkpane Mailer provides:
- Hosted form endpoints
- Inbox for form submissions
- Email notifications
- Newsletter subscription handling
- Simple SDKs for frontend integration
Learn more at https://linkpane.com/mailer-forms
This repository contains the official SDKs for interacting with Linkpane Mailer endpoints.
Install
npm install @linkpane/sdkUsage
import { submitForm, subscribeNewsletter } from '@linkpane/sdk'
await submitForm({
apiBaseUrl: 'https://api.linkpane.com',
pid: '12345',
slug: 'contact-me',
data: { firstName: 'Ada', lastName: 'Lovelace', email: '[email protected]' }
})
await subscribeNewsletter({
apiBaseUrl: 'https://api.linkpane.com',
username: 'my-newsletter',
data: { email: '[email protected]' }
})Which Package Should I Use?
- I want all →
@linkpane/sdk - I want to submit a custom contact/lead form →
@linkpane/mailer-post - I want to add newsletter subscribers →
@linkpane/newsletter-subscribe
Required Fields (Quick Guide)
Mailer form submissions require:
emailfirstNamelastName
Newsletter subscriptions typically require:
emailOptional:firstNamelastName
