ROroarkhq
HTTP Request Definition

Create HTTP request definition

Changed on

Creates a new HTTP request definition. The signing secret is only returned in this response and cannot be retrieved later.

post/v1/http-request-definition

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/http-request-definition
  • Auth
    HTTP bearer

Request body

scope'AGENT_OUTBOUND_DIAL' required

Scope: AGENT_OUTBOUND_DIAL

urlstring uri required

URL for the HTTP request

descriptionstring nullable

Description of the HTTP request definition

method'POST' | 'PUT' | 'PATCH' | 'GET'

HTTP method (default: POST)

headersobject

Request headers as key-value pairs

Response

The created HTTP request definition with signing secret

Changes

  • 571d359c5c01Revision changes
    • info

      added the required property ///// to the response with the status

  • 887b091b3d81Revision changes
    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status