Skip to main content
POST
Add Meta agent connector tool

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

connection_id
string
required

The ID of the connection

phone_number_id
string
required

The ID of the WhatsApp phone number the Meta agent runs on

connector_id
string
required

The ID of the connector

Body

name
string
required
Required string length: 1 - 256
Example:

"check_order_status"

description
string
required

What the tool does. The agent decides when to call it from this.

Required string length: 1 - 1024
request_definition
object
required
user_auth_required
boolean
required

Send the customer's own sign-in token with the call.

user_auth_action_config
object

Marks a tool that signs the customer in: where Meta reads the customer's token in the response.

transformation_spec
object | null

On an update, leave it out to keep it, or send null to remove it.

Response

200 - application/json
id
string
required
name
string
required
description
string
request_definition
object
user_auth_required
boolean
user_auth_action_config
object

Marks a tool that signs the customer in: where Meta reads the customer's token in the response.

transformation_spec
object

Up to 5 steps that trim the response before the agent reads it.