Create a channel connection

Create a new channel connection for a resource for given integration. Only one channel connection is allowed per resource and integration.

post/v1/channel-connections

Request

Base URL: https://api.notifly.io
URL: https://api.notifly.io/v1/channel-connections
Auth: API key in header Authorization

Request body

identifierstring

The unique identifier for the channel connection. If not provided, one will be generated automatically.

subscriberIdstring

The subscriber ID to link the channel connection to

contextobject

connectionMode'subscriber' | 'shared'

Connection mode that determines how the channel connection is scoped. Use "subscriber" (default) to associate the connection with a specific subscriber. Use "shared" to associate the connection with a context instead of a subscriber — subscriberId will not be stored on the connection.

integrationIdentifierstring required

The identifier of the integration to use for this channel connection.

Example request

{
  "identifier": "slack-prod-user123-abc4",
  "subscriberId": "subscriber-123",
  "connectionMode": "shared",
  "integrationIdentifier": "slack-prod",
  "workspace": {
    "id": "T123456",
    "name": "Acme HQ",
    "botUserId": "U0123456789"
  },
  "auth": {
    "accessToken": "Workspace access token",
    "refreshToken": "Workspace refresh token",
    "expiresAt": "2026-06-15T12:00:00.000Z",
    "refreshTokenExpiresAt": "2026-09-15T12:00:00.000Z"
  }
}

Response

Created

Example response

{
  "data": {
    "providerId": "slack",
    "integrationIdentifier": "slack-prod",
    "subscriberId": "subscriber-123",
    "contextKeys": [
      "tenant:org-123",
      "region:us-east-1"
    ],
    "workspace": {
      "id": "T123456",
      "name": "Acme HQ",
      "botUserId": "U0123456789"
    },
    "auth": {
      "accessToken": "Workspace access token",
      "refreshToken": "Workspace refresh token",
      "expiresAt": "2026-06-15T12:00:00.000Z",
      "refreshTokenExpiresAt": "2026-09-15T12:00:00.000Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.