Get an integration

GET

integrations

{id}

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

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

const { data, error } = await norbelys.integrations.find("int_9k4m2p");
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "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>"
}

{
  "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_….

Path Parameters

string

required

The resource id (path).

Response

config

IntegrationConfig · object | null

required

Per-connection settings: notification toggles, the Slack channel, and the CRM sync-direction settings.

Show child attributes

string

required

The integration id.

Example:

"intc_f7g3h9j5k1l7m3n9p5q1r7s3"

lastError

string | null

required

The last import or auth failure message, or null.

Example:

"invalid_grant: refresh token revoked"

provider

string

required

The connected app for this integration.

Minimum string length: 1

Example:

"slack"

status

enum<string>

required

Connection status: pending (authorization not finished yet), active, error (the credential needs a reconnect), or revoked.

Available options:

pending,

active,

error,

revoked

Example:

"active"

createdAt

any

Connect instant (RFC 3339).

lastSyncAt

any

When the last import ran (RFC 3339), or null before the first.

object

any

default:integration

Always "integration".

updatedAt

any

Last-update instant (RFC 3339).

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

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

const { data, error } = await norbelys.integrations.find("int_9k4m2p");
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "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>"
}

{
  "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

Get an integration

Authorizations

Path Parameters

Response