#The A Slack channel available for notification delivery object

A Slack channel available for notification delivery

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-integrations

Requires 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

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/slack-integrations" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "slackIntegration": {
    "createdAt": "2026-10-09T18:17:59.654Z",
    "createdBy": "string",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastSentAt": "2026-10-09T18:17:59.654Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "slackChannelId": "C01ABC123",
    "slackChannelName": "general",
    "slackTeamId": "T01ABC123",
    "slackTeamName": "My Company",
    "status": "SLACK_INTEGRATION_STATUS_UNSPECIFIED",
    "successCount": "string",
    "triggers": [
      "KIND_UNSPECIFIED"
    ],
    "updatedAt": "2026-10-09T18:17:59.654Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

GET

/v1/slack-integrations/channels

Requires 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

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/slack-integrations/channels" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "channels": [
    {
      "id": "string",
      "isMember": false,
      "isPrivate": false,
      "name": "string"
    }
  ]
}

Base URL: https://api.linkbreakers.com

GET

/v1/slack-integrations/oauth-url

Requires 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

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/slack-integrations/oauth-url" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "oauthUrl": "https://example.com"
}

Base URL: https://api.linkbreakers.com

POST

/v1/slack-integrations/oauth/complete

Requires 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

string

Required

The authorization code received from Slack

state

string

Required

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

object

Required

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/slack-integrations/oauth/complete" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"code":"string","state":"string"}'

Sample payload (application/json)

{
  "code": "string",
  "state": "string"
}

Typical response

{
  "slackIntegration": {
    "createdAt": "2026-10-09T18:17:59.655Z",
    "createdBy": "string",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastSentAt": "2026-10-09T18:17:59.656Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "slackChannelId": "C01ABC123",
    "slackChannelName": "general",
    "slackTeamId": "T01ABC123",
    "slackTeamName": "My Company",
    "status": "SLACK_INTEGRATION_STATUS_UNSPECIFIED",
    "successCount": "string",
    "triggers": [
      "KIND_UNSPECIFIED"
    ],
    "updatedAt": "2026-10-09T18:17:59.656Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

POST

/v1/slack-integrations/test

Requires 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

object

Required

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/slack-integrations/test" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Sample payload (application/json)

{}

Typical response

{
  "success": false
}

Base URL: https://api.linkbreakers.com

PATCH

/v1/slack-integrations

Requires 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

object

Required

Wrapped error response.

Example request (cURL)

curl -X PATCH "https://api.linkbreakers.com/v1/slack-integrations" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"linkId":"string","slackChannelId":"string","slackChannelName":"string","status":"SLACK_INTEGRATION_STATUS_UNSPECIFIED","triggers":["KIND_UNSPECIFIED"]}'

Sample payload (application/json)

{
  "linkId": "string",
  "slackChannelId": "string",
  "slackChannelName": "string",
  "status": "SLACK_INTEGRATION_STATUS_UNSPECIFIED",
  "triggers": [
    "KIND_UNSPECIFIED"
  ]
}

Typical response

{
  "slackIntegration": {
    "createdAt": "2026-10-09T18:17:59.655Z",
    "createdBy": "string",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastSentAt": "2026-10-09T18:17:59.655Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "slackChannelId": "C01ABC123",
    "slackChannelName": "general",
    "slackTeamId": "T01ABC123",
    "slackTeamName": "My Company",
    "status": "SLACK_INTEGRATION_STATUS_UNSPECIFIED",
    "successCount": "string",
    "triggers": [
      "KIND_UNSPECIFIED"
    ],
    "updatedAt": "2026-10-09T18:17:59.655Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

DELETE

/v1/slack-integrations

Requires 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

object

Required

Wrapped error response.

Slack Integrations

#The A Slack channel available for notification delivery object

#Get Slack integration

#Parameters

#Response

#Error response

#List Slack channels

#Parameters

#Response

#Error response

#Get Slack OAuth URL

#Parameters

#Response

#Error response

#Complete Slack OAuth

#Parameters

#Request body

#Response

#Error response

#Test Slack integration

#Parameters

#Request body

#Response

#Error response

#Update Slack integration

#Parameters

#Request body

Allowed values

#Response

#Error response

#Disconnect Slack integration

#Parameters

#Response

#Error response