Skip to main content
POST
/
api
/
v1
/
integrations
/
create
Create Integration
curl --request POST \
  --url https://api.example.com/api/v1/integrations/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "integration_type": "sentry",
  "auth_data": {
    "access_token": "<string>",
    "refresh_token": "<string>",
    "token_type": "Bearer",
    "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>"
}
'
{
  "success": true,
  "data": {
    "integration_id": "<string>",
    "name": "<string>",
    "integration_type": "sentry",
    "auth_data": {
      "access_token": "<string>",
      "refresh_token": "<string>",
      "token_type": "Bearer",
      "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>",
    "status": "active",
    "active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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,
confluence
​
auth_data
AuthData · object
required

Authentication data

​
scope_data
ScopeData · object
required

Scope-specific data

​
metadata
IntegrationMetadata · 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
Integration · object

Integration data if successful

​
error
string | null

Error message if operation failed