Sign in
Business Agent

Create a connector

Base URL plus how to authenticate (OAuth client credentials, API key or none). Names are unique per number. Not idempotent.

post/v1/accounts/{accountId}/business-agent/connectors

Path parameters

accountIdstring required

WhatsApp social account id (the number must be managed through the Cloud API).

Request body

namestring required

Unique per number.

descriptionstring

Tell the agent what the service provides.

base_urlstring uri required

Public HTTPS URL reachable from Meta.

connector_protocolstring
auth_type'OAUTH2_CLIENT_CREDENTIALS' | 'API_KEY' | 'NONE' required
requires_certificateboolean

Example request

{
  "connector_protocol": "HTTP",
  "auth_config": {
    "oauth2_client_credentials": {
      "token_request_content_type": "application/x-www-form-urlencoded"
    }
  },
  "user_auth_injection_config": {
    "location": "headers"
  }
}

Response

Connector created

namestring required

Unique per number.

descriptionstring

Tell the agent what the service provides.

base_urlstring uri required

Public HTTPS URL reachable from Meta.

connector_protocolstring
auth_type'OAUTH2_CLIENT_CREDENTIALS' | 'API_KEY' | 'NONE' required
requires_certificateboolean
idstring required
mcp_tool_syncobject
mtls_configobject

Example response

{
  "connector_protocol": "HTTP",
  "auth_config": {
    "oauth2_client_credentials": {
      "token_request_content_type": "application/x-www-form-urlencoded"
    }
  },
  "user_auth_injection_config": {
    "location": "headers"
  }
}

Changes