Link an integration

Redirects to the connect URL to link an integration.

GET /integrations/{integration_id}/connect

JavaScript

JavaScript

import Hyperspell from '@hyperspell/hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});

const response = await client.integrations.connect('integration_id');

console.log(response.expires_at);

200

{
  "url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

APIKeyAsUser

Authorization · string · header · required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

integration_id · string · required

Query Parameters

redirect_url · string | null

Response

200

application/json

Successful Response

url · string · required

expires_at · string<date-time> · required