API and webhooks · included in the Solo and Team plans
SoloWOS API and webhooks
Send bookings, payments and signatures to the rest of your tools the moment they happen.
Create an API key in Settings > Advanced > Developers, read and create contacts and invoices, list bookings, forms, proposals and expenses, and subscribe to 15 webhook events. Zapier and Make work through their webhook and HTTP modules, so you don't need to write code.
14 days free, no card needed · Then Basic for $2/month
IN SHORT
The SoloWOS API lets you read and create contacts and invoices, update pipeline stages and list bookings, form responses, proposals and expenses. 15 signed webhook events cover bookings, forms, proposals, signatures, invoices, pipeline changes and video views, and work with Zapier and Make. The API is included in Solo ($15/month) and Team ($35/month).
Prices and limits as of .
How it works
- 1
Create a key in Settings > Advanced > Developers
- 2
Add a webhook endpoint and pick events
- 3
Send a test event
- 4
Map the fields in Zapier, Make or your code
What you get
REST and JSON
Bearer keys, read only or read and write, 120 requests per minute per key, cursor pagination and the same error shape everywhere.
15 webhook events
From booking.created and form.submitted to invoice.paid, signature.completed and recording.viewed. Each payload includes the full record.
Signed and retried
Every delivery carries an HMAC-SHA256 signature. Failed ones are retried 5 more times over about 8 and a half hours.
Zapier and Make
Use Webhooks by Zapier or a Make custom webhook as the trigger, and their HTTP modules to create contacts or invoices.
Delivery log and test events
Each endpoint shows its last 50 deliveries and has a Send test event button.
Your data only
A key only sees its own workspace. Keys are stored as fingerprints and can be revoked instantly.
Works with these tools
- Schedulingbooking.created, canceled, rescheduled and no_show.
- Formsform.submitted, with the answers and the contact.
- InvoicingCreate invoices; invoice.sent and invoice.paid.
- E-Signaturessignature.completed.
- Screen Recordingrecording.viewed, with how much was watched.
What it doesn't do
- A listed Zapier or Make app
- Creating bookings or proposals by API
- OAuth for REST API apps (OAuth is used by the AI connector)
API reference
Basics
- Base URL:
https://solowos.com/api/v1- Auth:
Authorization: Bearer swos_live_…, keys from Settings > Advanced > Developers- Format:
- JSON in and out, dates in ISO 8601 (UTC), money as integer cents plus a currency
- Rate limit:
- 120 requests per minute per key, with
X-RateLimit-*headers - Pagination:
?limit(1 to 100) and?cursor, newest first
Webhook signatures
Each delivery has a SoloWOS-Signature: t=…,v1=… header: an HMAC-SHA256 of "<t>.<raw body>" keyed with the endpoint's whsec_… secret. Reject timestamps older than 5 minutes. Answer with a 2xx within 10 seconds; failures are retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours. Use the event id to ignore duplicates.
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /me | The workspace the key belongs to (connection test) |
| GET | /contacts | List contacts, filter by email or pipeline stage |
| POST | /contacts | Create a contact |
| GET | /contacts/{id} | One contact |
| PATCH | /contacts/{id} | Update a contact or move its pipeline stage |
| GET | /bookings | List bookings |
| GET | /booking-types | List meeting types |
| GET | /forms | List forms |
| GET | /forms/{id}/submissions | Responses to a form |
| GET | /proposals | List proposals |
| GET | /invoices | List invoices, filter by status |
| POST | /invoices | Create an invoice and get its public link |
| GET | /expenses | List expenses |
| GET | /webhooks | List webhook endpoints |
| POST | /webhooks | Subscribe an endpoint to events |
| DELETE | /webhooks/{id} | Remove an endpoint |
| GET | /webhooks/sample | A sample payload for an event |
Webhook events
| Event | Sent when |
|---|---|
| booking.created | A client books a meeting |
| booking.canceled | A meeting is canceled |
| booking.rescheduled | A meeting moves to a new time |
| booking.no_show | You mark a client as a no-show |
| form.submitted | Someone submits a form |
| proposal.sent | You send a proposal |
| proposal.viewed | A client opens a proposal |
| proposal.accepted | A client accepts a proposal |
| proposal.declined | A client declines a proposal |
| signature.completed | Everyone signs a document |
| invoice.sent | You send an invoice |
| invoice.paid | An invoice is paid |
| contact.stage_changed | A contact moves to another pipeline stage |
| link_page.signup | Someone joins your email list on your Link in Bio |
| recording.viewed | Someone watches a screen recording |
Zapier
- Create a Zap with Webhooks by Zapier, event Catch Hook, and copy its URL.
- In Settings > Advanced > Developers, add that URL as an endpoint and pick the events.
- Select Send test event, then Test trigger in Zapier.
- To create contacts or invoices, use Custom Request with your key in the Authorization header.
Make
- Add Webhooks > Custom webhook and copy the address.
- Add it as an endpoint in SoloWOS and pick the events.
- Select Redetermine data structure, then send a test event.
- For actions, use HTTP > Make a request with a JSON body and your key.
Questions
Is there a SoloWOS app in the Zapier directory?
Which plans include the API?
Can I create bookings or proposals through the API?
Can I connect SoloWOS to Claude or ChatGPT?
Does it cost extra?
Related pages
All 13 tools, for $15/month
14 days free, no card needed · Then Basic for $2/month.