Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json

Input for creating an HTTP request definition

scope
enum<string>
required

Scope: AGENT_OUTBOUND_DIAL

Available options:
AGENT_OUTBOUND_DIAL
url
string<uri>
required

URL for the HTTP request

description
string | null

Description of the HTTP request definition

method
enum<string>
default:POST

HTTP method (default: POST)

Available options:
POST,
PUT,
PATCH,
GET
body

Request body template. Accepts a JSON object or a string with placeholders like {{phoneNumberToDial}}. Objects are serialized to JSON for storage.

headers
object

Request headers as key-value pairs

Response

The created HTTP request definition with signing secret

data
object
required

HTTP request definition with signing secret (returned on creation)