Skip to content
Hooks Docs

Create an alert rule

POST
/v1/alerts/rules
curl --request POST \
  --url https://api.hooks.events/v1/alerts/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "type": "failure_rate", "targetType": "project", "targetId": "example", "threshold": 1, "windowSeconds": 900, "cooldownSeconds": 900, "channels": [ { "type": "email", "to": "" } ], "enabled": true }'

Requires the alerts:write scope.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
type
required
string
Allowed values: failure_rate consecutive_failures dead_letter_count circuit_breaker signature_failure_spike rate_limit_spike
targetType
string
default: project
Allowed values: project endpoint destination
targetId
Any of:
string
>= 1 characters <= 100 characters
threshold
required
integer
>= 1 <= 1000000
windowSeconds
integer
default: 900 >= 60 <= 604800
cooldownSeconds
integer
default: 900 >= 60 <= 86400
channels
required
Array
>= 1 items <= 5 items
One of:
object
type
required
string
Allowed value: email
to
Any of:
string format: email
/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
enabled
boolean
default: true

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json

Alert rule

object
key
additional properties

Example generated

{
  "additionalProperty": "example"
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

401

Section titled “401”

Missing or invalid credentials

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

403

Section titled “403”

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

429

Section titled “429”

Rate limited

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

Requests allowed per window

X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer

Seconds until the window resets