Build with your preferred coding tool
Connect your AI coding assistant
Give your coding tool the current Bridge docs. Choose it below for setup, an example prompt and a connection check.Docs access needs no Bridge API Key. Workspace access is separate.Choose your integration
REST API
Create contacts, conversations and messages from your server.Access: server-side
x-api-key.Webhooks
Receive Bridge events at your HTTPS endpoint.Access: verify webhook credentials and freshness.
Custom Connections
Capture landing-page leads and queue an opening WhatsApp message.Access:
captureKey and reCAPTCHA; no REST API Key.Make your first REST API request
Get your API credentials
Follow Authentication to generate an API key in the Bridge Admin Console. Ask your Bridge administrator for access if needed. Keep the key on your server.
Check the connection
Use your
x-api-key header to call the authenticated health check at https://api-connect-us.bridge.new/bridge/api/health.Continue in the REST API tab. Each endpoint lists its fields, responses, and examples.Custom Connections uses a separate endpoint and public
captureKey. Follow its integration guide. A 202 confirms acceptance, not WhatsApp delivery.Build from the published contract
- Create a Contact and send a message — follow the complete Contact → conversation → message workflow.
- Send a PDF or attachment — checksum, upload URL, file upload and message.
- Send a WhatsApp template — discover variables and supply caller-required values.
- Start Agent outbound and hand off — choose an Agent, understand
forceSend, reuse and recovery. - Look up identifiers and page through results — use the right IDs and cursors.
- Rate limits — share the request budget and handle
429responses. - Error codes — interpret REST API errors. Custom Connections has a separate error reference.
- WhatsApp template parameters — open conversations with WhatsApp templates and supply their variables.
- Changelog — review changes that affect integrations.