Send a test alert

POST

/api/v1/alerts/{alert_uuid}/test

const url = 'https://app.hostrepute.com/api/v1/alerts/01a178db-d7b6-7131-a50c-cb60224dd1cd/test';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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.hostrepute.com/api/v1/alerts/01a178db-d7b6-7131-a50c-cb60224dd1cd/test \
  --header 'Authorization: Bearer <token>'

Send one test alert to the channel so you can check it arrives. Webhook channels receive the alert.test event. You can send 5 test alerts per minute per team.

Needs the alert:update ability.

Authorizations

bearer

Parameters

Path Parameters

alert_uuid

required

string

The UUID of the alert channel.

Example

01a178db-d7b6-7131-a50c-cb60224dd1cd

Responses

202

application/json

object

message

string

Example

{
  "message": "Test alert sent."
}

404

No alert channel with this UUID in your team

application/json

object

message

string

Example

{
  "message": "No query results for model [App\\Models\\Alert] 01a178db-d7b6-7131-a50c-cb60224dd1cd"
}

422

The channel’s URL isn’t a public HTTPS address

application/json

object

message

string

errors

object

settings

Array<string>

Example

{
  "message": "The configured destination URL is not a valid public HTTPS endpoint.",
  "errors": {
    "settings": [
      "The configured destination URL is not a valid public HTTPS endpoint."
    ]
  }
}