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

Parameters that can be set when creating a External Connection

external_sip_connection
enum<string>
default:zoom
required

The service that will be consuming this connection.

Available options:
zoom
Example:

"zoom"

outbound
object
required
active
boolean
default:true

Specifies whether the connection can be used.

Example:

false

tags
string[]

Tags associated with the connection.

Example:
webhook_event_url
string<uri>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

webhook_event_failover_url
string<uri> | null
default:""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

webhook_timeout_secs
integer | null

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30
Example:

25

inbound
object

Response

Successful response

data
External Connection · object
Example: