Skip to main content
POST
Join the workspace's shared Slack channel

Authorizations

X-API-Key
string
header
required

Response

Successful Response

The workspace's shared Slack channel, and THIS caller's invitation to it.

Two independent facts rather than one status: the channel belongs to the organization, the invitation belongs to the person. A colleague of whoever created the channel sees it exists and is offered their own invitation, instead of being told they are already somewhere they cannot see.

channel_failure_message
string | null
required

What to tell the reader when provisioning failed. Null otherwise.

channel_name
string | null
required

The channel's name, without the leading hash. Null until it is ready.

channel_state
enum<string>
required

Where the workspace's channel is. 'none' means nobody has asked yet, and the page asks the moment it loads. 'provisioning' is the run that creates it, which the page polls. 'failed' carries a sentence.

Available options:
none,
provisioning,
ready,
failed
channel_url
string | null
required

A link that opens the channel in the reader's Slack. Null until it is ready.

invite_can_retry
boolean
required

Whether pressing the button again could plausibly work. False for a refusal about our own Slack workspace's settings, which no retry fixes.

invite_email
string | null
required

The address the invitation went to.

invite_message
string | null
required

What to tell the reader when Slack refused, already written for a person rather than a log. Null when nothing was refused.

invite_sent_at
string<date-time> | null
required

When Slack accepted the invitation.

invite_status
enum<string>
required

This caller's own invitation. Per person, because Slack binds an invitation to one email address.

Available options:
none,
sent,
refused
partner_joined
boolean | null
required

Whether anybody from the partner's workspace is actually in the channel. Null when we could not tell: there is no Slack event subscription, so this is a live read that is allowed to fail.