POST
/
api
/
v1
/
integrations
/
create
{
  "success": true,
  "data": {
    "integration_id": "<string>",
    "name": "<string>",
    "integration_type": "sentry",
    "status": "active",
    "active": true,
    "auth_data": {
      "access_token": "<string>",
      "refresh_token": "<string>",
      "token_type": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "scope": "<string>",
      "code": "<string>"
    },
    "scope_data": {
      "org_slug": "<string>",
      "installation_id": "<string>",
      "workspace_id": "<string>",
      "project_id": "<string>"
    },
    "metadata": {
      "instance_name": "<string>",
      "created_via": "oauth_callback",
      "version": "<string>",
      "description": "<string>",
      "tags": [
        "<string>"
      ]
    },
    "unique_identifier": "<string>",
    "created_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "error": "<string>"
}

Body

application/json

Request to create a new integration

name
string
required

Integration name

integration_type
enum<string>
required

Type of integration

Available options:
sentry,
github,
slack,
jira,
linear
auth_data
object
required

Authentication data

scope_data
object
required

Scope-specific data

metadata
object
required

Integration metadata

unique_identifier
string
required

Unique identifier for the integration

created_by
string
required

User creating the integration

Response

Successful Response

Response containing integration data

success
boolean
required

Whether the operation was successful

data
object | null

Integration data if successful Core integration model

error
string | null

Error message if operation failed