Developers — API, webhooks and AI connector
Choose a server-side API integration, signed event notifications, or the future Claude and ChatGPT connector, and understand their separate credentials and permissions.
Last updated: · Read as Markdown
Choose your integration
LeadKnight offers personal server-side Developer API keys and signed webhook notifications. The separate AI connector for Claude and ChatGPT is not available yet. The connector instructions describe what to do once it is turned on; an API key does not enable that connector.
| Your goal | Start here | Credential or setup |
|---|---|---|
| Connect your own backend, CRM sync or reporting service | Developer API | Create a personal key in Settings → Developer API; send it from your server only. |
| Receive contact changes and campaign status changes without repeatedly polling | Webhooks | Add a public HTTPS receiver in Settings and save its one-time signing secret. |
| Work in a workspace from Claude or ChatGPT after the connector becomes available | AI connector | Copy the address from Settings, connect using OAuth and choose one workspace on the consent page. |
| Give the future connector photos or videos from your device | Connector uploads | Open the upload link supplied in the conversation, upload in the correct workspace and return to the conversation. |
| Look up exact operations, request fields, response shapes and webhook bodies | API reference | Read the reference; use the live OpenAPI document for machine-readable contracts. |
Before connecting anything
- Sign in with the person whose access the integration should use. Select the intended workspace before creating a key or webhook.
- Confirm that this person has the current role, seat and access needed for the operation. A key or connection acts as that person; it cannot preserve access after membership or permissions change.
- Decide whether the integration only reads, edits drafts and CRM records, or also publishes and controls work. Choose the least powerful API key that meets the need.
- Prepare private server-side secret storage for API keys and webhook signing secrets. Do not put them in browser code, mobile apps, URLs, shared screenshots, source control or logs.
- Read the relevant how-to before enabling a write or send. A successful API response, campaign status or webhook is not proof that content was delivered to a social network or recipient.
Three mechanisms, not interchangeable credentials
Personal Developer API keys
An API key belongs to one person and one workspace. The HTTPS resource base URL is https://api.lead-knight.com/v1; resource calls use Authorization: Bearer <key>. Its read, write or publish ceiling is combined with the person's current role and seat. The key does not sign in to the app, manage other keys or authorize a Claude/ChatGPT connection.
Start with a read-only request. For mutations, retain the reviewed request and any required operation key before sending. Follow the Developer API recovery rules rather than automatically repeating a request with an uncertain result.
Signed outbound webhooks
Webhooks send HTTPS POST requests from LeadKnight to your receiver. They have a separate whsec_ signing secret, not an API bearer key. Verify signatures over the original raw body, check the attempt timestamp and deduplicate delivery IDs before applying changes. Deliveries can repeat and do not provide a complete change-history or social-delivery feed.
Use the webhook guide for endpoint requirements, event selection, signature verification, retries and disabled endpoints.
Future AI connector
The connector uses OAuth consent, not a personal API key. Each connected app is bound to one person and one chosen workspace. Its actions do not show LeadKnight approval cards: once available, review and explicitly confirm risky instructions in the host conversation before asking it to act.
Paid-ad launch and billing changes remain inside LeadKnight. The connector is not a replacement for the in-app assistant's approval flow. See AI connector availability and setup and the separate upload workflow.
If something goes wrong
| Symptom | What to check | Next step |
|---|---|---|
| You cannot see Developer API or Webhooks | Availability and your current workspace access; disabled features with no existing items can be hidden. | Check the intended workspace and current permissions. Existing keys or endpoints may still be visible for revocation or deletion. |
| The Claude/ChatGPT connector card or address is missing | The connector is not available yet; setup details are hidden while disabled. | Do not substitute an API key or invent a connector URL. Use the Developer API for supported server-side work. |
| A request works for one person but not another | Keys and webhook visibility use each person's own current access. | Check membership, role, seat and ownership/sharing, not only the key's selected ceiling. |
| A write times out | The server may already have completed it. | Inspect the current state and follow the applicable API or connector recovery instructions before sending anything again. |
| The webhook is accepted but your receiver applies a change twice | Delivery is at least once. | Store and deduplicate webhook-id, and acknowledge verified duplicates without repeating side effects. |