Skip to main content
POST
/
v1
/
webhook
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 webhook = await client.webhook.create({
  events: ['CALL_ANALYSIS_COMPLETED'],
  url: 'https://example.com',
});

console.log(webhook.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "url": "<string>",
    "headers": {},
    "events": [
      "CALL_ANALYSIS_COMPLETED"
    ],
    "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 a webhook

​
url
string<uri>
required

Webhook URL

​
events
enum<string>[]
required

Event types to subscribe to (at least one required)

Minimum array length: 1
Available options:
CALL_ANALYSIS_COMPLETED,
CALL_ANALYSIS_FAILED,
CALL_EVALUATION_COMPLETED,
CALL_EVALUATION_FAILED,
SIMULATION_RUN_PLAN_JOB_STARTED,
SIMULATION_RUN_PLAN_JOB_COMPLETED,
SIMULATION_RUN_PLAN_JOB_FAILED,
SIMULATION_RUN_PLAN_JOB_CANCELLED,
SIMULATION_JOB_STARTED,
SIMULATION_JOB_COMPLETED,
SIMULATION_JOB_FAILED,
SIMULATION_JOB_CANCELLED
​
description
string | null

Webhook description

​
headers
object

Request headers (e.g. authorization tokens)

Response

The created webhook with signing secret

​
data
object
required

Webhook response with signing secret (returned on creation)