> ## 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. # Registrar um lead de campanha > Registra um lead captado pela página de destino de um tenant e coloca na fila a primeira mensagem de saída do WhatsApp. Um 202 significa que o lead foi aceito, não que uma mensagem foi enviada. ## OpenAPI ````yaml /pt-br/api-reference/campaign-leads.openapi.yaml post /leadscout/campaign-leads openapi: 3.1.0 info: title: Bridge Campaign Leads API description: >- Endpoint público para registrar leads captados pela página de destino de um tenant. Não é necessária uma chave de API: quem chama é identificado pelo workspace e pela chave de captura, junto com um token do reCAPTCHA v3. version: 1.0.0 servers: - url: https://integrations-us.app.bridge.new/api/v1 security: [] paths: /leadscout/campaign-leads: post: tags: - Campaign leads summary: Registrar um lead de campanha description: >- Registra um lead captado pela página de destino de um tenant e coloca na fila a primeira mensagem de saída do WhatsApp. Um 202 significa que o lead foi aceito, não que uma mensagem foi enviada. operationId: create_campaign_lead_leadscout_campaign_leads_post parameters: - description: >- Obrigatório ao chamar de um navegador. Uma solicitação CORS preflight não tem corpo, portanto o tenant não pode ser resolvido nem Access-Control-Allow-Origin pode ser devolvido a menos que o workspace esteja na URL. Chamadas de servidor para servidor não fazem preflight e podem omiti-lo. required: false schema: anyOf: - type: string - type: 'null' title: Workspaceid description: >- Obrigatório ao chamar de um navegador. Uma solicitação CORS preflight não tem corpo, portanto o tenant não pode ser resolvido nem Access-Control-Allow-Origin pode ser devolvido a menos que o workspace esteja na URL. Chamadas de servidor para servidor não fazem preflight e podem omiti-lo. name: workspaceId in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CampaignLeadRequestDto' required: true responses: '202': description: >- Aceito e na fila. NÃO enviado: um serviço separado transmite a primeira mensagem depois. content: application/json: schema: $ref: '#/components/schemas/CampaignLeadAcceptedDto' '400': description: >- Payload malformado, telefone inutilizável, consentimento não concedido ou brand ausente. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsDto' '403': description: >- Captura desativada, chave de captura incorreta, captcha rejeitado ou origem não permitida. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsDto' '422': description: >- Não foi possível contatar o provedor de captcha. É transitório; é seguro tentar novamente. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsDto' '500': description: Falha inesperada. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsDto' components: schemas: CampaignLeadRequestDto: properties: workspaceId: type: string title: Workspaceid captureKey: type: string title: Capturekey cellphone: type: string title: Cellphone name: anyOf: - type: string - type: 'null' title: Name brandId: anyOf: - type: string - type: 'null' title: Brandid landingUri: type: string title: Landinguri utm: additionalProperties: type: string type: object title: Utm consent: $ref: '#/components/schemas/ConsentDto' recaptchaToken: type: string title: Recaptchatoken type: object required: - workspaceId - captureKey - cellphone - landingUri - consent - recaptchaToken title: CampaignLeadRequestDto description: Contrato de comunicação de `POST api/v1/leadscout/campaign-leads`. CampaignLeadAcceptedDto: properties: requestId: type: string title: Requestid description: >- ID de correlação deste envio. Presente apenas na aceitação; as respostas de erro não incluem um. type: object required: - requestId title: CampaignLeadAcceptedDto description: >- Corpo da resposta `202 Accepted`. Tem um nome em vez de ser apenas um `dict[str, str]` para que o schema publicado informe qual é o único campo e para que serve, em vez de “um objeto com propriedades de texto”. ProblemDetailsDto: properties: type: type: string title: Type description: Código de erro estável legível por máquinas. title: type: string title: Title description: Resumo breve legível por humanos. status: type: integer title: Status description: Código de status HTTP, repetido no corpo. detail: anyOf: - type: string - type: 'null' title: Detail description: Detalhamento opcional. Ausente na maioria das rejeições. type: object required: - type - title - status title: ProblemDetailsDto description: >- Detalhes de problema do RFC 9457, conforme emitidos pelo tratador global de exceções. O contexto é removido deliberadamente antes de chegar a quem chama: em um endpoint público, uma rejeição detalhada informa a um invasor em qual verificação ele falhou. ConsentDto: properties: status: $ref: '#/components/schemas/ConsentStatus' capturedAt: anyOf: - type: string format: date-time - type: 'null' title: Capturedat type: object required: - status title: ConsentDto description: >- Declaração do tenant de que o visitante deu permissão para receber mensagens. Isto NÃO é `CommercialConsentState`, nosso registro do ciclo de vida do consentimento de um contato. É uma afirmação externa que não podemos verificar: comprova o que nos foi informado e quando, que é o que apresentaríamos se o portfólio de um tenant fosse restringido. ConsentStatus: type: string enum: - GRANTED - NOT_PROVIDED title: ConsentStatus ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.