API overview
What you can connect to Nudge programmatically, where each interface lives and which one to pick.
What is available
Nudge gives developers four ways in. Each one answers a different need, so start by picking the right one.
| Interface | Base URL | Authentication | Use it to |
|---|---|---|---|
| MCP server | https://mcp.asknudge.ai | OAuth (your Nudge account) | Let an AI assistant (Claude, ChatGPT, Cursor…) read and manage your workspace with your own permissions |
| AI booking API | https://app.asknudge.ai/api/ai | None, limited per IP | Let an agent or a script read availability and book, cancel or move a meeting on one of your forms |
| Booking management | https://app.asknudge.ai/api/booking/{bookingId} | The booking's management token | Read, move, cancel or download (.ics) one existing meeting |
| Public form endpoints | https://app.asknudge.ai/api/public/{orgSlug}/{formSlug} | None | Read the public definition of a form and its hosts |
| Outgoing webhooks | Your own HTTPS URL | HMAC-SHA256 signature | Receive new leads in Zapier, Make, your CRM or your own backend |
All traffic is HTTPS. Requests and responses are JSON (UTF-8), except the .ics download.
Looking for a REST API with API keys?
Nudge does not offer API keys for workspace data today. To read or change contacts, bookings, forms, agents or settings from code or from an AI assistant, use the MCP server: it runs every action with the same permission checks as the app.
Which one should I use?
- You want an assistant to work in Nudge for you (list today's meetings, qualify a lead, update a form, add a webhook): connect the MCP server. The tool reference lists the 224 tools it exposes.
- You want an outside AI agent to book meetings with your team (a ChatGPT action, a voice bot, a partner site): use the AI booking API. It needs no key: the form slug and signed slots are enough, and you can switch it off per form.
- You want leads pushed to another tool as they arrive: create a webhook and read the event reference.
- You build your own page around an existing meeting (a custom "manage my booking" page): use the booking management endpoints.
Identifiers
Nudge never exposes internal database ids on public endpoints. Objects travel under public ids with a type prefix:
| Prefix | Object | Example |
|---|---|---|
frm_ | Form | frm_8k2m9q4t7v1x3z6c |
bk_ | Booking (meeting) | bk_4n7q2w9e5r1t8y3a |
cnt_ | Contact | cnt_6h3j8k1m4n7p2q5r |
tm_ | Team member (host) | tm_2v5b8n1m4k7j3h6g |
Workspaces and forms are also addressed by their slugs, the two parts of a public form URL: in https://app.asknudge.ai/acme/demo-request, acme is the workspace slug (orgSlug) and demo-request is the form slug (formSlug).
CORS
The AI booking API and the public form endpoints answer with Access-Control-Allow-Origin: *, so you can call them from any web page. The MCP server only accepts browser requests from the Nudge app, claude.ai and chatgpt.com; desktop and server-side clients, which send no Origin header, are not affected.
Limits and errors
Every public endpoint is rate limited per IP address and answers 429 Too Many Requests with a Retry-After header when you go over. See Rate limits for the figures and Errors for the error formats.