Skip to navigation

Get Event Join Link

Where attendees join: the link to hand out, the code they could type instead, and whether they need a passcode too. With qr=true, the link as an SVG QR code as well, for a slide or a poster. Needs events:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

eventIdstringRequired

Query parameters

qrbooleanOptional

Add qrSvg, the link as a QR code. False unless sent.

sizeintegerOptional

The QR code’s width in pixels, 160 to 1024 (kept within them). 512 unless sent.

Response

This endpoint returns an object.
eventIdstring
codestring
The code attendees can type instead of following the link.
joinUrlstring

The link to hand out: on the workspace’s own Dory hostname where it has one (https://events.acme.com/e/acme/bright-42), and on Taktoria’s domain otherwise. The code and the link do nothing until the event is LIVE.

hasPasscodeboolean
Whether attendees must type a passcode as well. The passcode itself is never returned.
qrSvgstringOptional

With qr=true: joinUrl as a QR code, SVG markup, black on white and size pixels square.

Errors

404
Not Found Error
422
Validation Error
429
Too Many Requests Error