Alerts

List Alerts

get

List all alerts.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[name]stringOptional

Filter results by name.

filter[type]stringOptional

Filter results by type.

includestringOptional

Comma-separated list of relationships to include. Available: notificationGroup, createdBy

sortstringOptional

Sort field. Prefix with - for descending. Available: name, type, created_at, last_triggered_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

OK

application/json

get/api/v1/alerts

GET /api/v1/alerts HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "type": "string",
      "config": {
        "threshold": "string"
      },
      "notification_group": {
        "id": 0,
        "company_id": 0,
        "name": "string",
        "created_at": "2025-01-15T10:30:00.000000Z",
        "updated_at": "2025-01-15T10:30:00.000000Z"
      },
      "last_triggered_at": null,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/alerts",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/alerts?page=1",
    "last": "https://api.example.com/api/v1/alerts?page=1",
    "prev": null,
    "next": null
  }
}

Create Alert

post

Create a new alert.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

OK

No content

422

Validation Error

application/json

post/api/v1/alerts

POST /api/v1/alerts HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Alert

get

Get a single alert.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

alertstringRequired

The alert identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[type]stringOptional

Filter results by type.

includestringOptional

Comma-separated list of relationships to include. Available: notificationGroup, createdBy

sortstringOptional

Sort field. Prefix with - for descending. Available: name, type, created_at, last_triggered_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

OK

No content

get/api/v1/alerts/{alert}

GET /api/v1/alerts/{alert} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Update Alert

put

Update an existing alert.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

alertstringRequired

The alert identifier.

Responses

200

OK

No content

422

Validation Error

application/json

put/api/v1/alerts/{alert}

PUT /api/v1/alerts/{alert} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete Alert

delete

Delete a alert.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

alertstringRequired

The alert identifier.

Responses

200

OK

No content

delete/api/v1/alerts/{alert}

DELETE /api/v1/alerts/{alert} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content