API reference
The Scribble API is a small REST API at https://scribblecards.com/api/v1. It sends cards, looks them up, and keeps contacts in step with your system. Authenticate with a bearer key, get JSON back, and receive signed webhooks when a card is written or mailed.
How do I authenticate with the Scribble API?Authenticate to the Scribble API with a bearer key created under Integrations. Keys are shown once, hashed at rest, scoped and revocable.What do Scribble API errors look like?Every Scribble API error is a JSON object with a stable code, a human-readable message and a docs link. Full list of codes by status.What are the Scribble API rate limits?Scribble API keys are limited to 120 requests a minute by default. A 429 carries a Retry-After header in seconds.Scribble cards API: send and look up a handwritten cardReference for the Scribble cards API: POST /api/v1/cards to send a handwritten card, GET /api/v1/cards to list, GET /api/v1/cards/{code} for one card's status.Scribble account API: keys, designs, handwritings and creditsCheck an API key, list your card designs and the handwritings on offer, and read your credit balance. The endpoints an integration calls before it sends anything.Scribble contacts API: create and list contactsReference for the Scribble contacts API: POST /api/v1/contacts upserts on external_id, GET /api/v1/contacts lists and filters the address book.Scribble inbound hooks: send a card from any toolReference for Scribble inbound hooks: one URL that sends one handwritten card per JSON POST, with a message template so the payload can be tiny.Scribble webhooks: get notified when a card is mailedReference for Scribble outbound webhooks: event types, payload shape, the HMAC-SHA256 signature scheme with working verification code, retries and the delivery log.
