Actions

The ballerinax/hubspot.crm.extensions.videoconferencing package exposes the following clients:

Client	Purpose
Client	Manage video conferencing application settings (webhook URLs) for a HubSpot app.

---

Client

Manage video conferencing application settings (webhook URLs) for a HubSpot app.

Configuration

Field	Type	Default	Description
apiKeyConfig	ApiKeysConfig	Required	API key configuration containing the HubSpot developer API key (hapikey).
config	ConnectionConfig	{}	HTTP client connection configuration.
serviceUrl	string	"https://api.hubapi.com/crm/v3/extensions/videoconferencing/settings"	Base URL for the HubSpot videoconferencing settings API.

Initializing the client

import ballerinax/hubspot.crm.extensions.videoconferencing as hsvideoconferencing;

configurable string hapikey = ?;

hsvideoconferencing:Client hubspot = check new ({hapikey});

Operations

Settings management

Get video conferencing settings for an app

Signature: get /[int:Signed32 appId]

Retrieves the video conferencing application settings (webhook URLs) currently configured for the specified app.

Parameters:

Name	Type	Required	Description
appId	int:Signed32	Yes	The ID of the video conference application.
headers	map<string|string[]>	No	Optional custom headers for the request.

Returns: ExternalSettings|error

Sample code:

hsvideoconferencing:ExternalSettings settings = check hubspot->/[appIdSigned32]();

Sample response:

{
  "createMeetingUrl": "https://my-conference.io/meetings/new",
  "updateMeetingUrl": "https://my-conference.io/meetings",
  "deleteMeetingUrl": "https://my-conference.io/meetings",
  "userVerifyUrl": "https://my-conference.io/verify-user"
}

Save video conferencing settings for an app

Signature: put /[int:Signed32 appId]

Creates or updates the video conferencing application settings (webhook URLs) for the specified app.

Parameters:

Name	Type	Required	Description
appId	int:Signed32	Yes	The ID of the video conference application.
payload	ExternalSettings	Yes	The video conferencing settings to save.
headers	map<string|string[]>	No	Optional custom headers for the request.

Returns: ExternalSettings|error

Sample code:

hsvideoconferencing:ExternalSettings settings = {
    createMeetingUrl: "https://my-conference.io/create-meeting",
    updateMeetingUrl: "https://my-conference.io/join-meeting",
    deleteMeetingUrl: "https://my-conference.io/record-meeting"
};
hsvideoconferencing:ExternalSettings result = check hubspot->/[appIdSigned32].put(settings);

Sample response:

{
  "createMeetingUrl": "https://my-conference.io/create-meeting",
  "updateMeetingUrl": "https://my-conference.io/join-meeting",
  "deleteMeetingUrl": "https://my-conference.io/record-meeting"
}

Delete video conferencing settings for an app

Signature: delete /[int:Signed32 appId]

Deletes all video conferencing application settings for the specified app.

Parameters:

Name	Type	Required	Description
appId	int:Signed32	Yes	The ID of the video conference application.
headers	map<string|string[]>	No	Optional custom headers for the request.

Returns: error?

Sample code:

check hubspot->/[appIdSigned32].delete();