Skip to main content

Platform API

The Platform API lets your agency connect Knock Knock App to an external platform you run — provisioning client companies programmatically, receiving signed webhook notifications as leads and calls come in, and signing your users straight into their Knock Knock workspace.

info

The Platform API is enabled per agency by the Knock Knock team on request. If you do not see the Platform APIs entry in your agency settings, reach out to hello@knockknockapp.ai to have it switched on.

Where to Find It​

Go to Agency Settings → Platform APIs. The screen has three tabs:

  • Credentials — your API key (shown masked) and its usage details. Rotating the key reveals the new secret once — copy it immediately, it cannot be retrieved later. Rotating immediately invalidates the current key.
  • Webhooks — the signing secret for outbound webhooks (also rotatable), the webhook endpoints you register, and a recent deliveries view where you can inspect each delivery attempt and retry it individually.
  • API Documentation — the full request/response reference with copyable samples, kept in-app so it always matches the current API.

What You Can Do with the API​

Send your API key as a request header; every request is scoped to your agency, so you can only see and manage your own companies. The API lets your platform:

  • Create companies — provision a new client company from your own signup flow.
  • List companies — enumerate the companies under your agency.
  • List a company's agents — retrieve the agents belonging to a specific company.

Outbound Webhooks​

Knock Knock signs and delivers webhook events to the endpoints you register, so your platform learns about activity without polling:

  • Lead capture — a new lead is captured for one of your companies.
  • Completed calls — a call finishes, including its outcome classification.

Payloads embed the full session record, and every delivery is signed with your webhook signing secret so you can verify it came from Knock Knock. A state parameter is carried through so you can correlate requests with the records on your side. Each endpoint receives events for all of your companies — the payload's company_id tells you which one an event belongs to.

If a delivery fails, open the deliveries view on the Webhooks tab to see the attempts and their errors, then use Retry now on the delivery once your endpoint is fixed.

Embedded Sign-On​

Companies created through the Platform API support embedded sign-on: your platform exchanges a secret for a session, and the user lands inside their Knock Knock workspace with no password screen. This makes Knock Knock feel like a native part of your own product.

Next Steps​

  • The exact endpoints, headers, and payloads live in-app under Agency Settings → Platform APIs → API Documentation
  • For per-company event notifications configured by your clients themselves, see Webhooks