> ## 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. # Descubrir las variables agnósticas de una plantilla > Devuelve las variables de una plantilla: `key`/`label`/`callerMustSupply`/`isCustom`/`default`, independientes de la ubicación en Meta. Nunca devuelve la dirección o el índice de una posición de Meta. `templateId` acepta el `id` o el `name` de la plantilla. Las operaciones salientes aceptan `template.id` o `template.name`, con prioridad para un id no vacío. El inicio de conversaciones utiliza `onboardingTemplates[].templateId`. Utiliza el selector que exige la operación de envío. Consulta [la receta de plantillas](/es/guides/send-template). Una variable con `callerMustSupply: true` no tiene una fuente declarada: quien llama debe incluir su `key` en `parameters` al enviar; de lo contrario, el envío falla con un 422 que identifica ese mismo `key`. Una variable con `callerMustSupply: false` la resuelve Bridge por su cuenta, por ejemplo, el nombre del destinatario, o ya tiene un valor que quien llama puede sobrescribir opcionalmente. Una variable con `isCustom: true` es un valor que solo conoce quien llama y tiene un `default`: envíala en `parameters` para usar tu propio valor, u omítela o déjala en blanco para enviar `default`. Códigos de error: - BRIDGE_CORE_0301: el workspace de la ruta no coincide con el workspace de quien llama (403) - BRIDGE_TEMPLATE_0001: no se encontró una PROVIDER_TEMPLATE para este workspace e identificador. Incluye por igual un id/name desconocido, una plantilla de otro workspace y una plantilla que no es PROVIDER_TEMPLATE (404); este endpoint nunca confirma la existencia de una plantilla fuera del workspace de quien llama ## OpenAPI ````yaml /es/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/templates/{templateId} openapi: 3.1.0 info: title: Bridge API summary: Especificación de la API de Bridge para gestionar el sistema de chat. description: >- Especificación de la API REST de integraciones de Bridge para gestionar contactos, conversaciones, mensajes, archivos, atributos personalizados, canales de proveedores, plantillas, usuarios internos y Agents. Los webhooks se documentan por separado en https://docs.bridge.new/es/webhooks; este OpenAPI contiene únicamente endpoints REST. **Arquitectura multiempresa**: las operaciones sobre recursos se limitan a un workspace específico mediante workspaceId. La comprobación de estado no incluye un workspace en su ruta. termsOfService: https://www.sainapsis.com/legal/terms-of-service contact: name: Bridge Support url: https://app.bridge.new/ email: support@sainapsis.com license: name: MIT License url: https://spdx.org/licenses/MIT.html version: 1.0.0 servers: - url: https://api-connect-us.bridge.new description: Servidor de producción security: [] paths: /bridge/api/v1/workspaces/{workspaceId}/templates/{templateId}: get: tags: - Templates API summary: Descubrir las variables agnósticas de una plantilla description: >- Devuelve las variables de una plantilla: `key`/`label`/`callerMustSupply`/`isCustom`/`default`, independientes de la ubicación en Meta. Nunca devuelve la dirección o el índice de una posición de Meta. `templateId` acepta el `id` o el `name` de la plantilla. Las operaciones salientes aceptan `template.id` o `template.name`, con prioridad para un id no vacío. El inicio de conversaciones utiliza `onboardingTemplates[].templateId`. Utiliza el selector que exige la operación de envío. Consulta [la receta de plantillas](/es/guides/send-template). Una variable con `callerMustSupply: true` no tiene una fuente declarada: quien llama debe incluir su `key` en `parameters` al enviar; de lo contrario, el envío falla con un 422 que identifica ese mismo `key`. Una variable con `callerMustSupply: false` la resuelve Bridge por su cuenta, por ejemplo, el nombre del destinatario, o ya tiene un valor que quien llama puede sobrescribir opcionalmente. Una variable con `isCustom: true` es un valor que solo conoce quien llama y tiene un `default`: envíala en `parameters` para usar tu propio valor, u omítela o déjala en blanco para enviar `default`. Códigos de error: - BRIDGE_CORE_0301: el workspace de la ruta no coincide con el workspace de quien llama (403) - BRIDGE_TEMPLATE_0001: no se encontró una PROVIDER_TEMPLATE para este workspace e identificador. Incluye por igual un id/name desconocido, una plantilla de otro workspace y una plantilla que no es PROVIDER_TEMPLATE (404); este endpoint nunca confirma la existencia de una plantilla fuera del workspace de quien llama operationId: >- get_template_discovery_bridge_api_v1_workspaces__workspaceId__templates__templateId__get parameters: - name: workspaceId in: path required: true schema: type: string format: uuid description: Identificador único del workspace (UUID v4). examples: - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234 title: Workspaceid description: Identificador único del workspace (UUID v4). - name: templateId in: path required: true schema: type: string description: 'ID o nombre de la plantilla: ambos identifican la misma plantilla.' examples: - order_shipped_promo - f0000040-0000-4000-8000-000000000040 title: Templateid description: 'ID o nombre de la plantilla: ambos identifican la misma plantilla.' responses: '200': description: Respuesta satisfactoria content: application/json: schema: $ref: '#/components/schemas/TemplateDiscoveryResponse' '403': description: Acceso prohibido content: application/json: examples: FORBIDDEN: value: title: Forbidden status: 403 code: BRIDGE_CORE_0301 schema: $ref: '#/components/schemas/Problem' '404': description: No encontrado content: application/json: examples: PROVIDER_TEMPLATE_NOT_FOUND: value: title: Provider Template Not Found status: 404 code: BRIDGE_TEMPLATE_0001 schema: $ref: '#/components/schemas/Problem' '422': description: Error de validación content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: Demasiadas solicitudes content: application/json: schema: $ref: '#/components/schemas/Problem' examples: WORKSPACE_BUDGET_EXHAUSTED: value: title: Too Many Requests status: 429 code: BRIDGE_RATE_LIMIT_0001 security: - x-api-key: [] components: schemas: TemplateDiscoveryResponse: properties: id: type: string title: Id description: Identificador único de la plantilla. examples: - f0000040-0000-4000-8000-000000000040 name: type: string title: Name description: Nombre de la plantilla, utilizado para identificarla al enviarla. examples: - order_shipped_promo language: type: string title: Language description: >- Idioma del pivot resuelto (idioma predeterminado de la plantilla), como código de Meta: es, en, pt_BR. examples: - es - pt_BR variables: items: $ref: '#/components/schemas/TemplateVariableResponse' type: array title: Variables description: Inventario agnóstico de las variables de esta plantilla. driftWarning: $ref: '#/components/schemas/TemplateDriftWarningResponse' title: Drift warning description: >- Diferencia entre declaración y snapshot, solo para diagnóstico. Nunca bloquea un envío. type: object required: - id - name - language - driftWarning title: TemplateDiscoveryResponse description: >- Inventario agnóstico de las variables de una plantilla para un cliente que debe enviarla sin conocer el modelo de Meta. examples: - id: f0000040-0000-4000-8000-000000000040 language: es name: order_shipped_promo driftWarning: hasDrift: false stale: [] missingLabels: [] variables: - callerMustSupply: false key: first_name label: Contact first name - callerMustSupply: false key: order_code label: Order code - callerMustSupply: false key: shipment_id label: Shipment ID - callerMustSupply: true key: promo_code label: Promo code Problem: properties: title: type: string title: Title description: Resumen breve del tipo de problema. status: type: integer title: Status description: >- Código de estado HTTP generado por el servidor de origen para esta instancia del problema. detail: anyOf: - type: string - type: 'null' title: Detail description: Explicación específica de esta instancia del problema. instance: anyOf: - type: string - type: 'null' title: Instance description: Referencia URI que identifica esta instancia del problema. traceId: anyOf: - type: string - type: 'null' title: Traceid description: ID de seguimiento para depuración. code: anyOf: - type: string - type: 'null' title: Code description: >- Código para identificar el error; consulta la página de códigos de error para más detalles. errors: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Errors description: Lista de detalles de errores. extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra description: Información adicional sobre el problema. type: object required: - title - status title: Problem description: Objeto que representa el cuerpo de una respuesta Problem. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError TemplateVariableResponse: properties: key: type: string title: Key description: Identificador agnóstico de esta variable, estable entre proveedores. examples: - tracking_code label: type: string title: Label description: Etiqueta legible de esta variable. examples: - Tracking code callerMustSupply: type: boolean title: Caller must supply description: >- Indica si el cliente debe proporcionar un valor para esta variable al enviar la plantilla: true si la plantilla no tiene un origen declarado para ese valor (por ejemplo, un código promocional que solo conoce el cliente) y false si Bridge lo resuelve por su cuenta (por ejemplo, desde el perfil del destinatario). examples: - true - false isCustom: type: boolean title: Is custom description: >- Indica si es una variable personalizada: un valor que solo conoce el cliente y que tiene un texto predeterminado. El cliente puede enviarlo en `parameters`; si se omite o se envía vacío, se utiliza `default`. default: false examples: - true - false default: anyOf: - type: string - type: 'null' title: Default description: >- Para una variable personalizada, el texto que se envía cuando quien llama no proporciona un valor; en los demás casos, null. examples: - pending - null type: object required: - key - label - callerMustSupply title: TemplateVariableResponse description: >- Variable de plantilla identificada por su clave agnóstica; aquí nunca aparece una dirección de slot de Meta. examples: - callerMustSupply: false isCustom: false key: first_name label: Contact first name - callerMustSupply: false default: pending isCustom: true key: tracking_code label: Tracking code - callerMustSupply: true isCustom: false key: promo_code label: Promo code TemplateDriftWarningResponse: properties: hasDrift: type: boolean title: Has drift stale: items: $ref: '#/components/schemas/TemplateVariableRef' type: array title: Stale description: Declarado, pero ya no requerido por el snapshot. missingLabels: items: $ref: '#/components/schemas/TemplateVariableRef' type: array title: Missing labels description: Requerido por el snapshot, pero aún no declarado. type: object required: - hasDrift title: TemplateDriftWarningResponse description: >- Diferencia, solo para diagnóstico, entre las variables declaradas y lo que requiere el snapshot de Meta. Según la regla de autoridad, esto nunca afecta el éxito de un envío: lo determina únicamente el snapshot. Permite que el cliente o la consola identifique una plantilla cuyas etiquetas necesitan actualizarse tras una edición realizada directamente en WhatsApp Manager. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError TemplateVariableRef: properties: key: type: string title: Key examples: - delivery_date label: type: string title: Label examples: - Delivery date type: object required: - key - label title: TemplateVariableRef description: >- Slot identificado solo por su clave y etiqueta agnósticas, sin dirección de slot de Meta. securitySchemes: x-api-key: type: apiKey description: Copy the API key as provided by the Bridge Console. in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.