Skip to main content
POST
/
v1
/
http-request-definition
JavaScript
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const httpRequestDefinition = await client.httpRequestDefinition.create({
  scope: 'AGENT_OUTBOUND_DIAL',
  url: 'https://example.com',
});

console.log(httpRequestDefinition.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scope": "AGENT_OUTBOUND_DIAL",
    "description": "<string>",
    "url": "<string>",
    "method": "POST",
    "body": "<string>",
    "parsedBody": {},
    "headers": {},
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "signingSecret": "<string>"
  }
}

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)