Skip to main content
POST
/
actions
Create an action
curl --request POST \
  --url https://api.open.cx/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "api_endpoint": "<string>",
  "payload": {
    "base_url": "<string>",
    "path": "<string>",
    "method": "<string>",
    "operationId": "<string>",
    "summary": "<string>",
    "description": "<string>",
    "parameters": [
      {
        "name": "<string>",
        "description": "<string>",
        "required": true,
        "schema": {}
      }
    ],
    "responses": {}
  },
  "description": "<string>",
  "operation_id": "<string>",
  "pinned": true,
  "tags": [
    "<string>"
  ],
  "require_form_submission": true
}
'
import requests

url = "https://api.open.cx/actions"

payload = {
    "name": "<string>",
    "api_endpoint": "<string>",
    "payload": {
        "base_url": "<string>",
        "path": "<string>",
        "method": "<string>",
        "operationId": "<string>",
        "summary": "<string>",
        "description": "<string>",
        "parameters": [
            {
                "name": "<string>",
                "description": "<string>",
                "required": True,
                "schema": {}
            }
        ],
        "responses": {}
    },
    "description": "<string>",
    "operation_id": "<string>",
    "pinned": True,
    "tags": ["<string>"],
    "require_form_submission": True
}
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({
    name: '<string>',
    api_endpoint: '<string>',
    payload: {
      base_url: '<string>',
      path: '<string>',
      method: '<string>',
      operationId: '<string>',
      summary: '<string>',
      description: '<string>',
      parameters: [{name: '<string>', description: '<string>', required: true, schema: {}}],
      responses: {}
    },
    description: '<string>',
    operation_id: '<string>',
    pinned: true,
    tags: ['<string>'],
    require_form_submission: true
  })
};

fetch('https://api.open.cx/actions', 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://api.open.cx/actions",
  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([
    'name' => '<string>',
    'api_endpoint' => '<string>',
    'payload' => [
        'base_url' => '<string>',
        'path' => '<string>',
        'method' => '<string>',
        'operationId' => '<string>',
        'summary' => '<string>',
        'description' => '<string>',
        'parameters' => [
                [
                                'name' => '<string>',
                                'description' => '<string>',
                                'required' => true,
                                'schema' => [
                                                                
                                ]
                ]
        ],
        'responses' => [
                
        ]
    ],
    'description' => '<string>',
    'operation_id' => '<string>',
    'pinned' => true,
    'tags' => [
        '<string>'
    ],
    'require_form_submission' => true
  ]),
  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://api.open.cx/actions"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"api_endpoint\": \"<string>\",\n  \"payload\": {\n    \"base_url\": \"<string>\",\n    \"path\": \"<string>\",\n    \"method\": \"<string>\",\n    \"operationId\": \"<string>\",\n    \"summary\": \"<string>\",\n    \"description\": \"<string>\",\n    \"parameters\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"required\": true,\n        \"schema\": {}\n      }\n    ],\n    \"responses\": {}\n  },\n  \"description\": \"<string>\",\n  \"operation_id\": \"<string>\",\n  \"pinned\": true,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"require_form_submission\": true\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://api.open.cx/actions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"api_endpoint\": \"<string>\",\n  \"payload\": {\n    \"base_url\": \"<string>\",\n    \"path\": \"<string>\",\n    \"method\": \"<string>\",\n    \"operationId\": \"<string>\",\n    \"summary\": \"<string>\",\n    \"description\": \"<string>\",\n    \"parameters\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"required\": true,\n        \"schema\": {}\n      }\n    ],\n    \"responses\": {}\n  },\n  \"description\": \"<string>\",\n  \"operation_id\": \"<string>\",\n  \"pinned\": true,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"require_form_submission\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.open.cx/actions")

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  \"name\": \"<string>\",\n  \"api_endpoint\": \"<string>\",\n  \"payload\": {\n    \"base_url\": \"<string>\",\n    \"path\": \"<string>\",\n    \"method\": \"<string>\",\n    \"operationId\": \"<string>\",\n    \"summary\": \"<string>\",\n    \"description\": \"<string>\",\n    \"parameters\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"required\": true,\n        \"schema\": {}\n      }\n    ],\n    \"responses\": {}\n  },\n  \"description\": \"<string>\",\n  \"operation_id\": \"<string>\",\n  \"pinned\": true,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"require_form_submission\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "api_endpoint": "<string>",
  "request_type": "<string>",
  "operation_id": "<string>",
  "payload": {
    "base_url": "<string>",
    "path": "<string>",
    "method": "<string>",
    "operationId": "<string>",
    "summary": "<string>",
    "description": "<string>",
    "parameters": [
      {
        "name": "<string>",
        "description": "<string>",
        "required": true,
        "schema": {}
      }
    ],
    "requestBody": {
      "content": {},
      "description": "<string>",
      "required": true
    },
    "responses": {}
  },
  "status": "<string>",
  "pinned": true,
  "tags": [
    "<string>"
  ],
  "enabled_on_channel": {
    "channels": []
  },
  "is_handoff_like": true,
  "require_form_submission": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Action display name

​
api_endpoint
string<uri>
required

The full API endpoint URL to call

​
request_type
enum<string>
required

HTTP method

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
​
payload
object
required

OpenAPI-style operation spec: parameters, requestBody, responses, etc.

​
description
string

What this action does

​
operation_id
string

Unique operation ID (auto-generated from name if omitted)

​
enabled_on_channel
object

Channel restrictions (defaults to web only)

​
pinned
boolean

Whether to pin this action prominently

​
tags
string[]

Tags for organizing actions

​
require_form_submission
boolean

Require the user to submit a form before executing

Response

Default Response

​
id
string
required

Unique action ID

​
name
string
required

Action display name

​
description
string | null
required

What this action does

​
api_endpoint
string | null
required

The API endpoint URL this action calls

​
request_type
string | null
required

HTTP method (GET, POST, PUT, PATCH, DELETE)

​
operation_id
string | null
required

Unique operation ID used to reference this action

​
payload
object | null
required

OpenAPI-style operation spec defining parameters, request body, and responses

​
status
string | null
required

Action status (e.g. "live")

​
pinned
boolean
required

Whether this action is pinned prominently

​
tags
string[]
required

Tags for organizing actions

​
enabled_on_channel
object
required

Channel restrictions

​
is_handoff_like
boolean
required

Whether this action behaves like a handoff to a human agent

​
require_form_submission
boolean | null
required

Whether a form must be submitted before the action executes

​
created_at
string<date-time>
required

When the action was created

​
updated_at
string<date-time>
required

When the action was last updated