Zernio
Zernio
API Reference

Meta Business Agent

Setup

Get agent setup statusGETCreate the agentPOSTList agent settingsGETUpdate agent settingsPATCHList allowlisted consumersGETAllowlist a consumerPOSTRemove an allowlisted consumerDELETE

Knowledge

Get business informationGETReplace business informationPUTReset business informationDELETEList FAQsGETCreate a FAQPOSTGet a FAQGETUpdate a FAQPUTDelete a FAQDELETEList crawled websitesGETAdd a website to crawlPOSTGet a crawled websiteGETUpdate a crawled websitePUTRemove a crawled websiteDELETEList knowledge filesGETUpload a knowledge filePOSTGet a knowledge fileGETDelete a knowledge fileDELETE

Skills

List skillsGETCreate a skillPOSTGet a skillGETUpdate a skillPUTDelete a skillDELETEList UI skillsGETCreate a UI skillPOSTGet a UI skillGETUpdate a UI skillPUTDelete a UI skillDELETE

Connectors

List connectorsGETCreate a connectorPOSTGet a connectorGETUpdate a connectorPUTDelete a connectorDELETESet connector credentialsPOSTRefresh MCP connector toolsPOSTGet connector failure logsGETList connector toolsGETCreate a connector toolPOSTGet a connector toolGETUpdate a connector toolPUTDelete a connector toolDELETERun a connector tool oncePOST

Operate

Get usage budgetsGETReplace usage budgetsPUTSend a test messagePOSTSend a business eventPOSTGet a business event statusGETRead evaluation dataGETStart an evaluation runPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Meta 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

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

accountId*string

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

{  "name": "string",  "description": "string",  "base_url": "http://example.com",  "connector_protocol": "string",  "auth_type": "OAUTH2_CLIENT_CREDENTIALS",  "auth_config": {    "oauth2_client_credentials": {      "token_url": "http://example.com",      "scopes_to_request": [        "string"      ],      "token_request_content_type": "string",      "client_id": "string",      "client_secret": "string"    },    "api_key": {      "headers": [        {          "field_name": "string",          "value": "string",          "prefix": "string"        }      ],      "query_params": [        {          "field_name": "string",          "value": "string",          "prefix": "string"        }      ],      "body_params": [        {          "field_name": "string",          "value": "string",          "prefix": "string"        }      ]    }  },  "user_auth_injection_config": {    "location": "string",    "field_name": "string",    "prefix": "string"  },  "requires_certificate": true,  "id": "string",  "mcp_tool_sync": {},  "mtls_config": {},  "connection_status": {    "status": "string",    "error_message": "string"  }}
Was this page helpful?

List connectors

External APIs the agent may call. `connection_status` says whether Meta can currently reach each one.

Get a connector

Next Page

name*string

Unique per number.

description?string

Tell the agent what the service provides.

base_url*string

Public HTTPS URL reachable from Meta.

Formaturi
connector_protocol?string
auth_type*string

Value in

  • "OAUTH2_CLIENT_CREDENTIALS"
  • "API_KEY"
  • "NONE"
auth_config?
user_auth_injection_config?
requires_certificate?boolean