Oakstack

Get one endpoint, including its inbound URL and signingSecret.

One event with its original headers, body, and every delivery attempt (status code, response snippet, error, duration). Use this to debug why the user's app rejected an event.

List the workspace's webhook endpoints with their inbound URL, forward URL, and status.

Recent events received by an endpoint, newest first, with delivery status (pending, delivering, delivered, failed), attempts, last response status, and last error. Filter with status 'failed' to find what needs attention.

Forward an event to the endpoint again (for example after fixing a bug in the user's webhook handler). Creates a new event linked by replayOf. Each replay counts as one event toward the plan's monthly limit.

Change the name or forwardUrl, or pause/resume forwarding with status 'paused' or 'active'. Pausing holds events (they are still accepted and stored) and forwards them all on resume.

Read photos, screenshots, PDFs (by public URL or base64) or pasted text and return structured data. Use template 'product-list' (products, quantities, condition, prices, pre-orders), 'receipt', or 'contacts', or pass your own JSON Schema. Returns data plus warnings for anything unclear. Counts pages against the monthly limit.

The hosted extraction templates with their JSON Schema.

Full documentation as markdown: 'overview' (setup, errors, limits), 'clock' (scheduled jobs), 'hook' (webhook relay), 'print' (PDFs and templates), 'post' (email), 'lens' (reading images and documents), 'ring' (text messages), 'bell' (push notifications), 'signatures' (verifying Oakstack-Signature).

The workspace's plan and this month's usage against each limit (jobs, webhook events, PDFs, emails, texts, push notifications, pages read). Check this before creating things if a limit might be close.

Add a domain to send from. Returns DNS records: the user must add the required ones (3 DKIM CNAMEs) at their DNS provider; the recommended ones improve deliverability. The domain verifies by itself once the records are live (minutes to hours).

Create an email address whose incoming mail is parsed (from, subject, text, html, attachments) and delivered as JSON to a webhook endpoint (create one with hook_create_endpoint first). Use it for support inboxes, reply handling, or email-to-app features.

One email with its body and every event: sent, delivered, bounced (with the receiving server's reason), complained, suppressed.

The workspace's sending domains with status (pending, verified, failed) and their DNS records.

Recent emails, newest first, with status (queued, sent, delivered, bounced, complained, failed, suppressed). Filter by status to debug.

Send a transactional email. `from` must use a verified domain (see post_add_domain). With an ok_test_ key nothing is delivered: delivery is simulated and logged (send to bounced@test.oakstack.dev or complained@test.oakstack.dev to simulate those). Attach a PDF with attachments: [{ filename, print: { template, data } }]. Returns the email with status 'queued'; check post_get_email for delivery.

Check whether live email can be sent from this workspace: whether sending is enabled, paused (after bounces or complaints), limited to workspace members (Free plan), and the current daily cap. Call this before setting up email.

Check a pending domain's DNS records right away instead of waiting for the automatic check.

Render a PDF from a full HTML document (`html`) or a hosted template (`template` + `data`). Returns the PDF with a private download `url` valid for an hour, page count, and size. Images and fonts in the HTML can be data: URLs or public https URLs. Counts against the monthly PDF limit.

One PDF with a fresh download url (valid an hour), its error if it failed, and any resources the page tried to load that were blocked.

Recent PDFs, newest first, with status (rendering, succeeded, failed), error, page count, and a fresh download url. Filter with status 'failed' to debug.

List the hosted PDF templates (invoice, proposal, report). Each has a JSON Schema for its data and a working example. Call this before print_create_pdf with a template.

Never text this phone again from this workspace (for example, someone who asked by email). STOP replies are added automatically.

One text with every event (sent, delivered, undelivered with Twilio's error code).

The workspace's toll-free numbers with their verification status (verifying, active, rejected with the reason) and the Oakhook endpoint replies go to.

Recent texts, newest first, sent and received (direction 'inbound' are replies). Status: queued, sent, delivered, undelivered, failed, opted_out, canceled, received.

Send an SMS to a US or Canadian phone. Comes from the workspace's approved toll-free number (or, before it's approved, the sandbox number to verified phones only). Include opt-out wording like 'Reply STOP to opt out.' in the first text to someone. With an ok_test_ key nothing is sent: delivery is simulated (+12025550180 simulates undelivered, +12025550181 carrier-filtered). Returns the text with status 'queued'; check ring_get_text for delivery.

Deliver texts people send to a number as JSON (object 'ring.inbound_message': from, to, body, media, optOut) to an Oakhook endpoint (create one with hook_create_endpoint). Pass hookEndpointId null to stop.

Check whether live texts (SMS) can go out from this workspace: whether texting is enabled, the plan allows it (not on Free), numbers and their toll-free verification, verified sandbox phones, and the next step. Call this before setting up texting.