Connect an app

POST

integrations

connect

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.integrations.connect({ provider: "slack" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "authorizationUrl": "https://backend.composio.dev/link/abc123",
  "integration": {
    "config": {
      "notify": {
        "campaignAutoPaused": true,
        "meetingBooked": true,
        "positiveReply": true,
        "reply": true
      },
      "pushOut": true,
      "slackChannelId": "C0123ABC456",
      "slackChannelName": "#wins",
      "syncIn": true
    },
    "id": "intc_f7g3h9j5k1l7m3n9p5q1r7s3",
    "lastError": "invalid_grant: refresh token revoked",
    "provider": "slack",
    "status": "active",
    "createdAt": "<unknown>",
    "lastSyncAt": "<unknown>",
    "object": "integration",
    "updatedAt": "<unknown>"
  },
  "expiresAt": "<unknown>"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Headers

Idempotency-Key

string

Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Maximum string length: 255

Body

application/json

provider

string

required

The app to connect.

Minimum string length: 1

Example:

"slack"

returnUrl

string<uri>

Where to send the user once they finish authorizing. Defaults to the workspace's integrations settings.

Example:

"https://app.norbelys.com/settings/integrations"

Response

authorizationUrl

string<uri>

required

Send the user here (popup or redirect) to authorize the app. The link expires.

Example:

"https://backend.composio.dev/link/abc123"

integration

Integration · object

required

The connection row, created pending — poll it (or list integrations) until it turns active.

Show child attributes

expiresAt

any

When the authorization link expires.

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.integrations.connect({ provider: "slack" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "authorizationUrl": "https://backend.composio.dev/link/abc123",
  "integration": {
    "config": {
      "notify": {
        "campaignAutoPaused": true,
        "meetingBooked": true,
        "positiveReply": true,
        "reply": true
      },
      "pushOut": true,
      "slackChannelId": "C0123ABC456",
      "slackChannelName": "#wins",
      "syncIn": true
    },
    "id": "intc_f7g3h9j5k1l7m3n9p5q1r7s3",
    "lastError": "invalid_grant: refresh token revoked",
    "provider": "slack",
    "status": "active",
    "createdAt": "<unknown>",
    "lastSyncAt": "<unknown>",
    "object": "integration",
    "updatedAt": "<unknown>"
  },
  "expiresAt": "<unknown>"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Authorizations

Headers

Body

Response