Integration

Find integrations in workspace

GET /v1/integration/workspace/:id

Find all integrations added in this workspace. email integrations are added default when workspace is first made.

Headers

Name	Value
Authorization	Bearer <token>

Path

Name	Type	Description
id	string	workspace_id

Response

200

[
  {
    "id": "integration_01j5fqx4btn8ccs7jqxagfvj47",
    "workspace_id": "workspace_01j50cn0hjhfr1e8ktpjgpdd5n",
    "name": "[e-mail]",
    "type": "EMAIL",
    "config": {
      "receiver": "[e-mail]"
    },
    "created_at": "2024-08-17 08:40:15",
    "updated_at": "2024-08-17 08:40:15"
  }
]

400

// workspace_id needed
{
  "success": false,
  "error": {
    "issues": [
      {
        "code": "invalid_type",
        "expected": "string",
        "received": "undefined",
        "path": [
          "workspace_id"
        ],
        "message": "Required"
      }
    ],
    "name": "ZodError"
  }
}

401

Unauthorized

Create a new user

POST /v1/integration/workspace/:id/email

Create an new email integration.

Headers

Name	Value
Authorization	Bearer <token>

Path

Name	Type	Description
id	string	workspace_id

Body

Name	Type	Description
name	string	name of the integration
config.receiver	string	email destination address

Request

It cannot create multiple email integrations with same email.

{
  "workspace_id": "workspace_01j50cn0hjhfr1e8ktpjgpdd5n",
  "name": "primary",
  "config": {
    "receiver": "[e-mail]"
  }
}

Response

200

{
  "id": "integration_01j5fwhqz9n2nq19ntf2y4rzge",
  "workspace_id": "workspace_01j50cn0hjhfr1e8ktpjgpdd5n",
  "name": "primary",
  "type": "EMAIL",
  "config": {
    "receiver": "[e-mail]"
  },
  "created_at": "2024-08-17 10:01:25",
  "updated_at": "2024-08-17 10:01:25"
}

400

{
  "message": "email already exists"
}

401

Unauthorized

Find integrations in monitor

GET /v1/integration/monitor/:id

Find all integrations ON in monitor.

Headers

Name	Value
Authorization	Bearer <token>

Path

Name	Type	Description
id	string	monitor_id

Response

200

[
  {
    "integration_id": "integration_01j5g752d4651h3xak8ytwmbt1",
    "monitor_id": "monitor_01j50cvmj4ykr3c22zcrmnnwb2",
    "status": "ON",
    "created_at": "2024-08-17 13:15:18",
    "updated_at": "2024-08-17 13:15:18"
  }
]

400

{
  "message": "monitor id is required"
}

401

Unauthorized

403

{
  "message": "forbidden"
}

Activate monitor integration

POST /v1/integration/monitor/:id

Activate integrations (that exist in workspace) for monitor. When monitor is UP or DOWN it sends alert based on the added integrations in the monitor.

Headers

Name	Value
Authorization	Bearer <token>

Path

Name	Type	Description
id	string	monitor_id

Body

Name	Type	Description
integration_id	string

Response

201

{
  "integration_id": "integration_01j5g752d4651h3xak8ytwmbt1",
  "monitor_id": "monitor_01j50cvmj4ykr3c22zcrmnnwb2",
  "status": "ON",
  "created_at": "2024-08-17 13:15:18",
  "updated_at": "2024-08-17 13:15:18"
}

400

{
  "message": "integration already exists"
}

401

Unauthorized

403

{
  "message": "forbidden"
}

404

{
  "message": "integration not found"
}

{
  "message": "monitor not found"
}

Deactivate monitor integration

DELETE /v1/integration/monitor/:id

Deactivate integrations (that exist in workspace) for monitor.

Headers

Name	Value
Authorization	Bearer <token>

Path

Name	Type	Description
id	string	monitor_id

Body

Name	Type	Description
integration_id	string

Response

201

{ 
  "message": "success" 
}

400

{
  "message": "integration not found in monitor"
}

{
  "message": "integration not found in workspace"
}

401

Unauthorized

403

{
  "message": "forbidden"
}

404

{
  "message": "integration not found"
}

{
  "message": "monitor not found"
}