← Back to API Reference overview

Slack Integrations

Endpoints for managing the Slack integration. Connect your Slack workspace to receive real-time notifications when events occur on your links.

Shortcut: ⌘K

#The A Slack channel available for notification delivery object

A Slack channel available for notification delivery

id

string

The Slack channel ID

isMember

boolean

Whether the bot is a member of this channel (can post to it)

isPrivate

boolean

Whether this is a private channel

name

string

The channel name

GET/v1/slack-integrationsRequires auth

#Get Slack integration

Retrieve the Slack integration configuration for the workspace.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

slackIntegration

object

Represents a connected Slack workspace integration that receives event notifications in a configured channel when workflow steps complete.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/slack-integrations/channelsRequires auth

#List Slack channels

List available Slack channels the bot can send notifications to.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

channels

array<object>

Available channels the bot can post to

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/slack-integrations/oauth-urlRequires auth

#Get Slack OAuth URL

Returns the Slack OAuth authorization URL to initiate the Add to Slack flow.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

oauthUrl

string

The full Slack OAuth authorization URL to redirect the user to

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/slack-integrations/oauth/completeRequires auth

#Complete Slack OAuth

Exchanges the Slack authorization code for a bot token and creates the workspace integration.

#Parameters

This endpoint does not accept any parameters.

#Request body

code

stringRequired

The authorization code received from Slack

state

stringRequired

The state parameter for CSRF validation

#Response

200

Everything worked as expected.

slackIntegration

object

Represents a connected Slack workspace integration that receives event notifications in a configured channel when workflow steps complete.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/slack-integrations/testRequires auth

#Test Slack integration

Send a test notification to verify the Slack integration is working.

#Parameters

This endpoint does not accept any parameters.

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

success

boolean

Whether the test notification was sent successfully

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PATCH/v1/slack-integrationsRequires auth

#Update Slack integration

Update the Slack integration configuration (channel, triggers, status).

#Parameters

This endpoint does not accept any parameters.

#Request body

linkId

string

Filter notifications by a specific link ID

slackChannelId

string

The Slack channel ID to send notifications to

slackChannelName

string

The Slack channel name

status

string (enum)

The status of a Slack integration

Allowed values
SLACK_INTEGRATION_STATUS_UNSPECIFIED

Status not specified

SLACK_INTEGRATION_STATUS_ACTIVE

Integration is active and sending notifications

SLACK_INTEGRATION_STATUS_PAUSED

Integration is paused by user action

SLACK_INTEGRATION_STATUS_DISCONNECTED

Integration is disconnected

triggers

array<string (enum)>

Filter notifications by workflow step kinds

#Response

200

Everything worked as expected.

slackIntegration

object

Represents a connected Slack workspace integration that receives event notifications in a configured channel when workflow steps complete.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

DELETE/v1/slack-integrationsRequires auth

#Disconnect Slack integration

Disconnect and remove the Slack integration from the workspace.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.