Update an alert rule

PATCH

/v1/alerts/rules/{id}

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

• Production

Requires the alerts:write scope.

Authorizations

• apiKey
• sessionCookie

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 80 characters

type

string

Allowed values: failure_rate consecutive_failures dead_letter_count circuit_breaker signature_failure_spike rate_limit_spike

targetType

string

Allowed values: project endpoint destination

targetId

Any of:

string

string

>= 1 characters <= 100 characters

null

null

threshold

integer

>= 1 <= 1000000

windowSeconds

integer

>= 60 <= 604800

cooldownSeconds

integer

>= 60 <= 86400

channels

Array

>= 1 items <= 5 items

One of:

object

object

type

required

string

Allowed value: email

to

Any of:

string

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,}$/

string

string

object

object

type

required

string

Allowed value: slack

webhookUrl

required

string

/^\{\{secret\.(?<name>[A-Z][A-Z0-9_]{0,63})\}\}$/

object

object

type

required

string

Allowed value: webhook

url

required

string

/^\{\{secret\.(?<name>[A-Z][A-Z0-9_]{0,63})\}\}$/

enabled

boolean

Responses

200

Success

Media typeapplication/json

object

ok

required

boolean

key

additional properties

Example ^generated

{
  "ok": true
}

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

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

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"
  }
}

404

Resource not found

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

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

X-RateLimit-Limit

integer

Requests allowed per window

X-RateLimit-Remaining

integer

X-RateLimit-Reset

integer

Seconds until the window resets