Developer Platform

Build with the Propper API

Integrate document signing and agreement workflows into your applications. Our REST API, webhooks, and SDKs make it easy to build powerful integrations.

Get Started API Reference

REST API

Full-featured REST API for creating, sending, and managing documents. Comprehensive endpoints for all Propper features.

View Examples

Webhooks

Real-time event notifications for document status changes. Build event-driven integrations that respond instantly.

View Events

SDKs

Official SDKs for popular languages. Get started quickly with type-safe, idiomatic code for your platform.

View SDKs

Quick Start

Get up and running in minutes with these code examples

Install the SDK

npm install @propper/sdk

Send a Document for Signature

import { Propper } from '@propper/sdk';

const propper = new Propper({
  apiKey: process.env.PROPPER_API_KEY,
});

const document = await propper.documents.create({
  title: 'Sales Agreement',
  file: fs.readFileSync('./contract.pdf'),
  signers: [
    {
      email: 'signer@example.com',
      name: 'John Doe',
    },
  ],
});

await propper.documents.send(document.id);

console.log('Document sent:', document.id);

Webhook Events

Subscribe to webhook events to receive real-time notifications when document status changes.

document.createdA new document was created

document.sentDocument was sent for signature

document.viewedRecipient viewed the document

document.signedRecipient signed the document

document.completedAll signatures collected

document.declinedRecipient declined to sign

document.expiredDocument signing period expired

Example Webhook Payload

{
  "event": "document.signed",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "document_id": "doc_abc123",
    "title": "Sales Agreement",
    "signer": {
      "email": "signer@example.com",
      "name": "John Doe",
      "signed_at": "2025-01-15T10:30:00Z"
    },
    "status": "partially_signed",
    "signers_completed": 1,
    "signers_total": 2
  }
}