logo

Integrations

Endpoints related to managing a hub's integrations.

Get Integration

Retrieves details of a single Integration associated with the current hub.

Requires the hubs-integrations-view capability.

SecuritybearerAuth
Request
path Parameters
integrationId
required
string^[a-f0-9]{24}$

The ID of the Integration to retrieve.

query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "definition"
Responses
200

Details of the specified Integration

default

General error response from the platform

get/v1/hubs/current/integrations/{integrationId}
Response samples
application/json
{
  • "data": {
    }
}

Update Integration

Updates the specified Integration within the current hub. If the Integration definition specifies that it requires verification, then you must submit a verify task to enable it.

SecuritybearerAuth
Request
path Parameters
integrationId
required
string^[a-f0-9]{24}$

The ID of the Integration to update.

query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "definition"
Request Body schema: application/json
required
name
string or null

A new name for the Integration.

identifier
string (Identifier)

A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of my-container and is automatically created by the platform.

The identifier does not have to be unique.

IntegrationAuth (object) or null
object or null

Updated key-value pairs associated with the Integration.

Responses
200

Returns the updated Integration.

default

General error response from the platform

patch/v1/hubs/current/integrations/{integrationId}
Request samples
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "auth": {
    },
  • "extra": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Delete an Integration

Deletes the specified Integration from the current hub, marking it as deleted and returning the updated Integration.

SecuritybearerAuth
Request
path Parameters
integrationId
required
string^[a-f0-9]{24}$

The ID of the Integration to delete.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/hubs/current/integrations/{integrationId}
Response samples
application/json
{
  • "data": {
    }
}

List Integrations

Lists all integrations associated with the current Hub, with optional filtering.

Requires the hubs-integrations-view capability.

SecuritybearerAuth
Request
query Parameters
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "definition"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for. Supports filtering by state and a text search.

Responses
200

A list of integrations

default

General error response from the platform

get/v1/hubs/current/integrations
Response samples
application/json
{
  • "data": [
    ]
}

Create Integration

Create an Integration resource within a hub. If the Integration definition specifies that it requires verification, then you must submit a verify task to enable it.

SecuritybearerAuth
Request
query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "definition"
Request Body schema: application/json
required

Parameters for creating an Integration.

name
string or null

A name for the Integration.

vendor
required
string

Unique vendor for the Integration, subject to validation.

identifier
string (Identifier)

A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of my-container and is automatically created by the platform.

The identifier does not have to be unique.

object

Authentication information for the Integration.

object

Additional key-value pairs associated with the Integration.

Responses
201

Returns the new Integration.

default

General error response from the platform

post/v1/hubs/current/integrations
Request samples
application/json
{
  • "name": "string",
  • "vendor": "string",
  • "identifier": "string",
  • "auth": {
    },
  • "extra": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Get Available Integrations

Returns a map of available integrations categorized by their type.

SecuritybearerAuth and hubAuth
Responses
200

A map of categories to lists of integration definitions.

default

General error response from the platform

get/v1/hubs/current/integrations/available
Response samples
application/json
{
  • "data": {
    }
}

Create a new Hub Integration Job.

Creates a new Job targeted at the provided Hub Integration.

Required Permissions

  • Requires a valid hub membership to the target hub.
  • Requires the hubs-integrations-manage capability.
SecuritybearerAuth and hubAuth
Request
path Parameters
integrationId
required
string

The ID of the Hub Integration.

Request Body schema: application/json

Parameters for creating a new Hub Integration Job.

action
required
string

The type of Job/selected Job action to create.

Value: "verify"
Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/hubs/current/integrations/{integrationId}/tasks
Request samples
application/json
{
  • "action": "verify"
}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Members