---
title: "Integrations: Slack API Reference | Linkbreakers"
description: "Post scans, visits and form submissions on your links to a Slack channel as they happen."
canonical: "https://linkbreakers.com/help/api/integrations-slack"
---

# Integrations: Slack

Post scans, visits and form submissions on your links to a Slack channel as they happen.

6 entries on this page

## The slack integration object

SlackIntegration.

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

`createdAt` string (date-time) 

Read-only

The timestamp when the integration was connected

`createdBy` string

The member who connected the integration (UUID)

`delivery` object

Where, when and what it sends.

8 child attributes

`directoryIds` array of string

Where: directories it applies to, with every directory below them.

`linkIds` array of string

Where: links it applies to. All three lists empty means every link.

`moments` array of enum

When: the moments of a visit it sends at. Ignored when stepIds is set.

`stepIds` array of string

When: send only when a visit reaches one of these workflow steps.

`tagIds` array of string

Where: tags it applies to.

`targetsGone` boolean 

Read-only

Every link, directory and tag chosen has since been deleted, so this covers nothing. The lists above are then empty without meaning every link.

`visitorAttributeKeys` array of string

What: with SELECTED, the attribute keys sent, such as "$email" or "rating".

`visitorData` enum

How much of what is known about the visitor an integration sends.

Allowed values

* `INTEGRATION_VISITOR_DATA_NONE` Only the visit: the link, the step, the device and the place.
* `INTEGRATION_VISITOR_DATA_ALL` The visit, and every attribute known about the visitor.
* `INTEGRATION_VISITOR_DATA_SELECTED` The visit, and only the attributes named in visitorAttributeKeys.

`failureCount` integer (int64) 

Read-only

Count of failed notification deliveries

`id` string

The unique identifier of the Slack integration (UUID)

`lastSentAt` string (date-time) 

Read-only

The timestamp when a notification was last sent

`linkId` string

Filter notifications by a specific link ID. Only events from this link will trigger notifications. If empty, all links in the workspace will trigger notifications.

`slackChannelId` string

The Slack channel ID where notifications are sent

`slackChannelName` string

The Slack channel name where notifications are sent

`slackTeamId` string

The Slack team/workspace ID

`slackTeamName` string

The Slack team/workspace name

`status` enum

Current status of the integration

Allowed values

* `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

`successCount` integer (int64) 

Read-only

Count of successful notification deliveries

`triggers` array of enum

Filter notifications by workflow step kinds. Only workflow steps matching these kinds will trigger notifications. If empty, all workflow step kinds will trigger notifications.

`updatedAt` string (date-time) 

Read-only

The timestamp when the integration was last updated

`workspaceId` string

The workspace ID this integration belongs to (UUID)

Example slack integration

```json
{
  "createdAt": "2026-01-15T09:30:00Z",
  "createdBy": "string",
  "delivery": {
    "directoryIds": [
      "string"
    ],
    "linkIds": [
      "string"
    ],
    "moments": [
      "KIND_ENTRY"
    ],
    "stepIds": [
      "string"
    ],
    "tagIds": [
      "string"
    ],
    "targetsGone": false,
    "visitorAttributeKeys": [
      "string"
    ],
    "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
  },
  "failureCount": 0,
  "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "lastSentAt": "2026-01-15T09:30:00Z",
  "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "slackChannelId": "C01ABC123",
  "slackChannelName": "general",
  "slackTeamId": "T01ABC123",
  "slackTeamName": "My Company",
  "status": "SLACK_INTEGRATION_STATUS_ACTIVE",
  "successCount": 0,
  "triggers": [
    "KIND_ENTRY"
  ],
  "updatedAt": "2026-01-15T09:30:00Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}
```

### Response

200

`slackIntegration` object

The Slack integration, absent when Slack is not connected

Fields: [The slack integration object](#integrations-slack-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/slack-integrations" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "slackIntegration": {
    "createdAt": "2026-01-15T09:30:00Z",
    "createdBy": "string",
    "delivery": {
      "directoryIds": [
        "string"
      ],
      "linkIds": [
        "string"
      ],
      "moments": [
        "KIND_ENTRY"
      ],
      "stepIds": [
        "string"
      ],
      "tagIds": [
        "string"
      ],
      "targetsGone": false,
      "visitorAttributeKeys": [
        "string"
      ],
      "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
    },
    "failureCount": 0,
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastSentAt": "2026-01-15T09:30:00Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "slackChannelId": "C01ABC123",
    "slackChannelName": "general",
    "slackTeamId": "T01ABC123",
    "slackTeamName": "My Company",
    "status": "SLACK_INTEGRATION_STATUS_ACTIVE",
    "successCount": 0,
    "triggers": [
      "KIND_ENTRY"
    ],
    "updatedAt": "2026-01-15T09:30:00Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Response

200

`channels` array of object

Available channels the bot can post to

4 child attributes

`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

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

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

Response 200

```json
{
  "channels": [
    {
      "id": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
      "isMember": false,
      "isPrivate": false,
      "name": "string"
    }
  ]
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

An empty JSON object.

### Response

200

`success` boolean

Whether the test notification was sent successfully

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/slack-integrations/test" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json"
```

Response 200

```json
{
  "success": false
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`delivery` object

Where, when and what it sends. When set, it replaces the whole setting and takes over from triggers and linkId. Leave it out to keep the current one.

7 child attributes

`directoryIds` array of string

Where: directories it applies to, with every directory below them.

`linkIds` array of string

Where: links it applies to. All three lists empty means every link.

`moments` array of enum

When: the moments of a visit it sends at. Ignored when stepIds is set.

`stepIds` array of string

When: send only when a visit reaches one of these workflow steps.

`tagIds` array of string

Where: tags it applies to.

`visitorAttributeKeys` array of string

What: with SELECTED, the attribute keys sent, such as "$email" or "rating".

`visitorData` enum

How much of what is known about the visitor an integration sends.

Allowed values

* `INTEGRATION_VISITOR_DATA_NONE` Only the visit: the link, the step, the device and the place.
* `INTEGRATION_VISITOR_DATA_ALL` The visit, and every attribute known about the visitor.
* `INTEGRATION_VISITOR_DATA_SELECTED` The visit, and only the attributes named in visitorAttributeKeys.

`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` enum

Integration status (ACTIVE or PAUSED)

Allowed values

* `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 of enum

Filter notifications by workflow step kinds

### Response

200

`slackIntegration` object

The updated Slack integration

Fields: [The slack integration object](#integrations-slack-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PATCH "https://api.linkbreakers.com/v1/slack-integrations" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "delivery": {
    "directoryIds": [
      "string"
    ],
    "linkIds": [
      "string"
    ],
    "moments": [
      "KIND_ENTRY"
    ],
    "stepIds": [
      "string"
    ],
    "tagIds": [
      "string"
    ],
    "visitorAttributeKeys": [
      "string"
    ],
    "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
  },
  "linkId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "slackChannelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "slackChannelName": "string",
  "status": "SLACK_INTEGRATION_STATUS_ACTIVE",
  "triggers": [
    "KIND_ENTRY"
  ]
}'
```

Response 200

```json
{
  "slackIntegration": {
    "createdAt": "2026-01-15T09:30:00Z",
    "createdBy": "string",
    "delivery": {
      "directoryIds": [
        "string"
      ],
      "linkIds": [
        "string"
      ],
      "moments": [
        "KIND_ENTRY"
      ],
      "stepIds": [
        "string"
      ],
      "tagIds": [
        "string"
      ],
      "targetsGone": false,
      "visitorAttributeKeys": [
        "string"
      ],
      "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
    },
    "failureCount": 0,
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastSentAt": "2026-01-15T09:30:00Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "slackChannelId": "C01ABC123",
    "slackChannelName": "general",
    "slackTeamId": "T01ABC123",
    "slackTeamName": "My Company",
    "status": "SLACK_INTEGRATION_STATUS_ACTIVE",
    "successCount": 0,
    "triggers": [
      "KIND_ENTRY"
    ],
    "updatedAt": "2026-01-15T09:30:00Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Response

200

An empty JSON object.

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/slack-integrations" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

---

Source: https://linkbreakers.com/help/api/integrations-slack
