Send a test notification

POST

/api/v1/account_integration/{account_integration_id}/test

const url = 'https://app.prefactorai.com/api/v1/account_integration/013xrzp12g3nqk8ns6jadrqmpgrjkeny/test';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: 'null'
};

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/013xrzp12g3nqk8ns6jadrqmpgrjkeny/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data null

Authorizations

authorization

Parameters

Path Parameters

account_integration_id

required

AccountIntegration_Id

A valid account integration ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

Request Body

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

Responses

200

Success

application/json

object

delivered

required

Whether Slack accepted the test notification

boolean

status

required

string

Allowed values: success

Example

{
  "delivered": true,
  "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"
}