> ## Documentation Index > Fetch the complete documentation index at: https://docs.bridge.new/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Bridge exposes three integration surfaces: the REST Integrations API for pushing data into Bridge, webhooks for receiving events from Bridge, and the public Custom Connections endpoint that a tenant's landing page posts to. > The Integrations API host is https://api-connect-us.bridge.new and every request to it must be authenticated with the x-api-key header. Bridge does not use bearer tokens or OAuth. > The Custom Connections endpoint is different and the Integrations API rules do not apply to it: it has its own host, it takes no x-api-key and no authentication header of any kind, and it is called from a visitor's browser. It is identified by a workspace id and a capture key together with a reCAPTCHA token. Never tell a reader to authenticate it with an API key, and never tell them to keep its capture key out of frontend code - it is designed to live in the page. > REST error catalog keys use BRIDGE__, for example BRIDGE_CONVERSATION_0001. Some reviewed legacy handlers return a recognized code plus a symbolic suffix separated by |; preserve the complete received value and use the compatible catalog lookup on /error-codes. Custom Connections uses separate BRIDGE.CAMPAIGN_LEADS. identifiers on its own error reference. Never invent an error code or confuse the two integration surfaces. > This documentation covers the Integrations API, webhooks and Custom Connections only. It does not describe the Bridge web application or its internal APIs. > Before generating an API request, read the relevant OpenAPI specification or the individual endpoint Markdown page. llms-full.txt collects guides and endpoint descriptions; it does not embed every request and response schema. The REST and Custom Connections contracts are separate. > Preserve the published host, method, path, operationId, authentication, headers, parameter and field names, types, formats, required and nullable fields, enums, defaults, limits, and response codes. Do not invent identifiers, fields, retry rules, or delivery guarantees. When published sources conflict, identify the conflicting passages and ask Bridge support to confirm the current behavior before relying on it. > Custom Connections is the current name of the landing-page feature previously documented as Lead Capture. The existing /lead-capture documentation URLs, captureKey field, campaign-leads endpoint, and BRIDGE.CAMPAIGN_LEADS error identifiers are unchanged. This is a naming change, not a change to authentication or the API contract. > For a complete workflow, start with the task guides: /guides/first-conversation, /guides/send-attachments, /guides/send-template, /guides/agent-outbound, /guides/pagination, /guides/identifiers and /guides/responses. Read the endpoint contract as well as the recipe. Outbound requires an existing Contact, but does not require creating a separate Conversation first. > forceSend=true permits reuse of an existing active conversation; it does not create a fresh one by ignoring it and it is not idempotency. Recovery of a released recoverable conversation can occur even with false. The LeadScout and Agents outbound routes have different line-selection and controller checks; use /guides/agent-outbound. > For webhook HMAC, follow /webhooks/verifying-signatures exactly: the Python JSON serialization with sorted keys is signed; X-Bridge-Timestamp is not included in that signature. Do not claim a signed timestamp, raw-body signing, exactly-once delivery or a global event order. Use /webhooks/receive-events for durable acceptance and duplicates. > A 201 message response, 202 handoff or 202 Custom Connections response is not a provider delivery receipt. Do not invent a polling endpoint from messageId, trackingId or requestId. REST validation parsing must tolerate the compatibility difference explained in /error-codes. > The documentation is available in English (existing root URLs), Spanish (/es/) and Brazilian Portuguese (/pt-br/). Prefer the reader's language when a localized page exists, but preserve the API's exact field names, enums, routes, authentication and examples. Translations describe the same API; they do not introduce regional API hosts or behaviors. > For coding-assistant setup, use /connect-your-agent, /es/connect-your-agent or /pt-br/connect-your-agent. The Bridge documentation MCP server reads published documentation and has a separate optional feedback tool. Connecting it does not connect the coding assistant to a customer workspace or authorize live business requests. > For direct HTTP access without MCP, start at https://docs.bridge.new/llms.txt. It lists every published page in English, Spanish and Brazilian Portuguese. Choose /llms-en.json, /llms-es.json or /llms-pt-br.json for a language-specific index, and /llms-full-en.json, /llms-full-es.json or /llms-full-pt-br.json for collected content. /llms-full.txt contains the combined collection. Fetch the original OpenAPI specification for exact schemas. > For HTTP page reads, follow the .md URLs from the index or request Accept: text/markdown at the canonical page URL. The MCP virtual filesystem uses .mdx page paths instead; .mdx is not the public HTTP export extension. With Search MCP, set language to en, es or pt-BR explicitly; its default is en. > For integration capabilities and source-selection rules, read https://docs.bridge.new/skill.md. Documentation access does not authorize business API actions; use the actual user request, workspace, credentials and target identifiers for any live integration. # Integre seus sistemas ao Bridge > Conecte seu CRM, automações ou landing page ao Bridge com a API REST, webhooks e Custom Connections. Implemente com sua ferramenta de programação preferida ## Conecte seu assistente de programação com IA Conecte sua ferramenta à documentação atual do Bridge. Escolha abaixo para ver a configuração, um exemplo de prompt e o teste de conexão. [Codex ](https://docs.bridge.new/pt-br/connect-your-agent.md#codex) [Claude Code ](https://docs.bridge.new/pt-br/connect-your-agent.md#claude-code) [Cursor ](https://docs.bridge.new/pt-br/connect-your-agent.md#cursor) [GitHub Copilot ](https://docs.bridge.new/pt-br/connect-your-agent.md#github-copilot) O acesso à documentação não exige chave de API do Bridge. O acesso ao workspace é separado. ## Escolha sua integração > [card] [API REST](https://docs.bridge.new/pt-br/credentials.md) > > Crie contatos, conversas e mensagens a partir do seu servidor. > > **Acesso:** `x-api-key` no servidor. > [card] [Webhooks](https://docs.bridge.new/pt-br/webhooks.md) > > Receba eventos do Bridge no seu endpoint HTTPS. > > **Acesso:** verifique as credenciais do webhook e a validade temporal. > [card] [Custom Connections](https://docs.bridge.new/pt-br/lead-capture.md) > > Capture leads de uma landing page e coloque a mensagem inicial de WhatsApp na fila de envio. > > **Acesso:** `captureKey` e reCAPTCHA; sem chave da API REST. ## Faça sua primeira requisição à API REST **1. Obtenha suas credenciais de API** Siga o guia de [autenticação](https://docs.bridge.new/pt-br/credentials.md) para gerar uma chave de API no console administrativo do Bridge. Se necessário, peça acesso ao administrador do Bridge. Mantenha a chave no servidor. **2. Verifique a conexão** Use o cabeçalho `x-api-key` para chamar o [health check](https://docs.bridge.new/pt-br/api-reference/health/verificar-integridade.md) autenticado em `https://api-connect-us.bridge.new/bridge/api/health`. Continue na aba **API REST**. Cada endpoint apresenta seus campos, respostas e exemplos. > [!NOTE] > > Custom Connections usa um endpoint separado e uma `captureKey` pública. Siga o [guia de integração](https://docs.bridge.new/pt-br/lead-capture/integration.md). Uma resposta `202` confirma a aceitação, não a entrega no WhatsApp. ## Implemente com base no contrato publicado * [Crie um Contato e envie uma mensagem](https://docs.bridge.new/pt-br/guides/first-conversation.md) — siga o fluxo completo: Contato → conversa → mensagem. * [Envie um PDF ou anexo](https://docs.bridge.new/pt-br/guides/send-attachments.md) — checksum, URL de upload, envio do arquivo e mensagem. * [Envie um template de WhatsApp](https://docs.bridge.new/pt-br/guides/send-template.md) — descubra as variáveis e forneça os valores exigidos do integrador. * [Inicie uma conversa com um Agente e transfira o atendimento](https://docs.bridge.new/pt-br/guides/agent-outbound.md) — escolha o Agente e entenda `forceSend`, reutilização e recuperação. * [Consulte identificadores](https://docs.bridge.new/pt-br/guides/identifiers.md) e [percorra os resultados paginados](https://docs.bridge.new/pt-br/guides/pagination.md) — use os IDs e cursores corretos. * [Limites de requisições](https://docs.bridge.new/pt-br/rate-limits.md) — compartilhe a cota de requisições e trate respostas `429`. * [Códigos de erro](https://docs.bridge.new/pt-br/error-codes.md) — interprete os erros da API REST. Custom Connections tem uma [referência de erros](https://docs.bridge.new/pt-br/lead-capture/errors.md) separada. * [Parâmetros de templates de WhatsApp](https://docs.bridge.new/pt-br/templates-and-parameters.md) — abra conversas com templates de WhatsApp e forneça suas variáveis. * [Histórico de alterações](https://docs.bridge.new/pt-br/changelog.md) — consulte mudanças que afetam as integrações. Leia sem MCP pelo [índice trilíngue](https://docs.bridge.new/llms.txt), [índice em português](https://docs.bridge.new/llms-pt-br.json), [documentação reunida em português](https://docs.bridge.new/llms-full-pt-br.json) ou [guia para agentes de IA](https://docs.bridge.new/skill.md). Consulte os esquemas exatos no [OpenAPI da API REST de integrações](https://docs.bridge.new/pt-br/api-reference/openapi.yaml) ou no [OpenAPI de Custom Connections](https://docs.bridge.new/pt-br/api-reference/campaign-leads.openapi.yaml). Para ajuda sobre o uso do aplicativo Bridge, visite a [Central de Ajuda](https://help.bridge.new). This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.