Create a connector tool

Create a new tool for the specified connector.

post

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters

connector_idstringRequired

The unique identifier of the parent connector

Header parameters

X-API-Versionstring · enumOptional

Meta Business Agent API version

Possible values:

Body

application/json

Tool to create

descriptionstringRequired

namestringRequired

user_auth_requiredbooleanRequired

Responses

201

The newly created tool

application/json

A single connector tool

descriptionstringRequired

idstringRequiredExample: 1234567890

namestringRequired

user_auth_requiredbooleanRequired

400

Bad request

application/json

401

Unauthorized

application/json

429

Too many requests

application/json

500

Server error

application/json

post/agent_connectors/{connector_id}/tools

HTTPcURLJavaScriptPython

POST /agent_connectors/{connector_id}/tools HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1107

{
  "description": "text",
  "name": "text",
  "request_definition": {
    "body": {
      "content_type": "application/json",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": {
          "binding": {
            "kind": "default",
            "macro": "WHATSAPP_PHONE_NUMBER",
            "value": "text"
          },
          "description": "text",
          "items": "text",
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "required": [
            "text"
          ],
          "type": "object"
        }
      },
      "required": [
        "text"
      ]
    },
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "binding": {
          "kind": "default",
          "macro": "WHATSAPP_PHONE_NUMBER",
          "value": "text"
        },
        "description": "text",
        "required": true,
        "type": "string"
      }
    },
    "method": "GET",
    "path": "text",
    "path_parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "binding": {
          "kind": "default",
          "macro": "WHATSAPP_PHONE_NUMBER",
          "value": "text"
        },
        "description": "text",
        "required": true,
        "type": "string"
      }
    },
    "query_parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "binding": {
          "kind": "default",
          "macro": "WHATSAPP_PHONE_NUMBER",
          "value": "text"
        },
        "description": "text",
        "required": true,
        "type": "string"
      }
    }
  },
  "user_auth_action_config": {
    "expires_at_path": "text",
    "expires_at_type": "absolute",
    "refresh_token_path": "text",
    "user_action_tool_type": "auth",
    "user_auth_token_path": "text"
  },
  "user_auth_required": true
}

{
  "description": "text",
  "id": "1234567890",
  "name": "text",
  "request_definition": {
    "body": {
      "content_type": "application/json",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": {
          "binding": {
            "kind": "default",
            "macro": "WHATSAPP_PHONE_NUMBER",
            "value": "text"
          },
          "description": "text",
          "items": "text",
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "required": [
            "text"
          ],
          "type": "object"
        }
      },
      "required": [
        "text"
      ]
    },
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "binding": {
          "kind": "default",
          "macro": "WHATSAPP_PHONE_NUMBER",
          "value": "text"
        },
        "description": "text",
        "required": true,
        "type": "string"
      }
    },
    "method": "GET",
    "path": "text",
    "path_parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "binding": {
          "kind": "default",
          "macro": "WHATSAPP_PHONE_NUMBER",
          "value": "text"
        },
        "description": "text",
        "required": true,
        "type": "string"
      }
    },
    "query_parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "binding": {
          "kind": "default",
          "macro": "WHATSAPP_PHONE_NUMBER",
          "value": "text"
        },
        "description": "text",
        "required": true,
        "type": "string"
      }
    }
  },
  "user_auth_action_config": {
    "expires_at_path": "text",
    "expires_at_type": "absolute",
    "refresh_token_path": "text",
    "user_action_tool_type": "auth",
    "user_auth_token_path": "text"
  },
  "user_auth_required": true
}