Skip to main content

getCommsURL()

function getCommsURL(params: CommsURLParams): string;

Builds a relative Comms URL based on the provided parameters

Parameters

ParameterTypeDescription
paramsCommsURLParamsURL parameters including workspace, channel, conversation, thread, etc.

Returns

string

A relative URL path

Example

getCommsURL({ workspaceId: 1, channelId: '7Yp...', threadId: '7Yq...' })
// returns '/a/1/ch/7Yp.../t/7Yq.../'