Create an account integration

POST

/api/v1/account_integration

const url = 'https://app.prefactorai.com/api/v1/account_integration';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"config":{"_version":1,"webhook_url":"https://hooks.slack.com/services/T123/B456/secret"},"integration_type":"slack","status":"active"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.prefactorai.com/api/v1/account_integration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": { "_version": 1, "webhook_url": "https://hooks.slack.com/services/T123/B456/secret" }, "integration_type": "slack", "status": "active" }'

Authorizations

authorization

Request Body

AccountIntegration_DetailsForCreate

object

config

required

Versioned integration config, including any required secrets

object

key

additional properties

any

Example

{
  "_version": 1,
  "webhook_url": "https://hooks.slack.com/services/T123/B456/secret"
}

integration_type

required

Integration type key

string

Example

slack

status

required

Whether this integration is active or paused

string

Allowed values: active paused

Example

active

Responses

200

Success

application/json

object

details

required

AccountIntegration_Details

object

config

required

Versioned integration config. Secrets such as the Slack webhook URL are redacted.

object

key

additional properties

any

required

AccountIntegration_Id

A valid account integration ID

string

integration_type

required

Integration type key for this account

string

status

required

Whether this integration is active or paused

string

Allowed values: active paused

type

required

Type of resource (always ‘account_integration’)

string

Allowed values: account_integration

status

required

string

Allowed values: success

Example

{
  "details": {
    "config": {
      "_version": 1,
      "enabled_events": [
        "agent_created"
      ],
      "webhook_url": {
        "$sensitive": "string",
        "labels": [
          "authentication_and_secrets"
        ]
      }
    },
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "integration_type": "slack",
    "status": "active",
    "type": "account_integration"
  },
  "status": "success"
}

default

Error

application/json

One of:

object

code

required

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_state alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used temporarily_unavailable conflict

message

required

string

status

required

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}