Actions

Test an HTTP action with a real request

Requires actions:http:execute. This makes a REAL HTTP request to the configured endpoint and can change external data. Only use on an explicit test request. Never retry automatically: a repeated request is a new invocation and may repeat side effects. Preserves existing duplicate protection, receipts and diagnostics; reconcile an uncertain result before a deliberate new invocation. Other families return ACTION_OPERATION_NOT_SUPPORTED. An invocation failure may return HTTP 200 with ok:false. Write-capable tests require confirmExternalEffects=true and the current configurationVersion. Obtain explicit user confirmation for this individual real HTTP request; never infer consent from management scopes or retry automatically. Missing/stale confirmation returns HTTP_TEST_CONFIRMATION_REQUIRED (403) before dispatch. Read-only tests do not require consent. This confirmation requirement also applies to deprecated Tools write tests: older clients must explicitly confirm and send configurationVersion. Explicit new Off mode returns ACTION_INACTIVE (403); historical inactive definitions without an explicit mode retain direct-test eligibility. No test endpoint for Sheets or collection actions; use Playground.

POST

actions

{actionId}

test

Test an HTTP action with a real request

curl --request POST \
  --url https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {},
  "confirmExternalEffects": true,
  "configurationVersion": "<string>"
}
'

import requests

url = "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test"

payload = {
    "input": {},
    "confirmExternalEffects": True,
    "configurationVersion": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({input: {}, confirmExternalEffects: true, configurationVersion: '<string>'})
};

fetch('https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => [
        
    ],
    'confirmExternalEffects' => true,
    'configurationVersion' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test"

	payload := strings.NewReader("{\n  \"input\": {},\n  \"confirmExternalEffects\": true,\n  \"configurationVersion\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": {},\n  \"confirmExternalEffects\": true,\n  \"configurationVersion\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": {},\n  \"confirmExternalEffects\": true,\n  \"configurationVersion\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "durationMs": 123,
  "output": {},
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

Server-side tenant-scoped credential created from Build > API Keys.

Path Parameters

actionId

string

required

Body

application/json

input

object

confirmExternalEffects

boolean

Set true only after explicit user confirmation for this real write-capable HTTP test. Read-only tests do not require confirmation.

configurationVersion

string

Exact current configurationVersion from the tool configuration; required for write-capable tests.

Response

Successful action operation

boolean

required

durationMs

integer

required

output

object

error

object

Show child attributes

Test an HTTP action with a real request

curl --request POST \
  --url https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {},
  "confirmExternalEffects": true,
  "configurationVersion": "<string>"
}
'

import requests

url = "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test"

payload = {
    "input": {},
    "confirmExternalEffects": True,
    "configurationVersion": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({input: {}, confirmExternalEffects: true, configurationVersion: '<string>'})
};

fetch('https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => [
        
    ],
    'confirmExternalEffects' => true,
    'configurationVersion' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test"

	payload := strings.NewReader("{\n  \"input\": {},\n  \"confirmExternalEffects\": true,\n  \"configurationVersion\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": {},\n  \"confirmExternalEffects\": true,\n  \"configurationVersion\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": {},\n  \"confirmExternalEffects\": true,\n  \"configurationVersion\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "durationMs": 123,
  "output": {},
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

{
  "error": {
    "code": "M2M_AUTH_INSUFFICIENT_SCOPE",
    "message": "M2M credential does not have required scope.",
    "details": {
      "requiredScopes": [
        "conversations:write"
      ],
      "missingScopes": [
        "conversations:write"
      ]
    }
  }
}

Channels

Conversations

Custom tools

WhatsApp templates

Commerce

Properties

Knowledge

Sales CRM

Delivery

Reporting

Webhooks

API Reference

Actions

Test an HTTP action with a real request

Authorizations

Path Parameters

Body

Response