Systemhook API specification (2.0.0)

Download OpenAPI specification:Download

The systemhook service implements all systemhook functions for GroupAlarm

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: Personal-Access-Token

systemhook

CreateSystemhook

Creates a new system hook

Request Body schema: application/json
id
integer <int64>

id of the systemhook

name
required
string

name of the systemhook

organizationID
required
integer <int64>

id of the containing organization

service
required
string

name of the services for this system hook

url
required
string

url of the systemhook

Responses

200

alarm system hook successfully created/updated

400

Passed parameters missing or in wrong format

500

Unexpected database error

post /systemhook
https://app.groupalarm.com/api/v1/systemhook

Request samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "service": "string",
  • "url": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "service": "string",
  • "url": "string"
}

UpdateSystemhook

Updates the existing system hook with the passed id

path Parameters
id
required
int64

id of the systemhook

Request Body schema: application/json
id
integer <int64>

id of the systemhook

name
required
string

name of the systemhook

organizationID
required
integer <int64>

id of the containing organization

service
required
string

name of the services for this system hook

url
required
string

url of the systemhook

Responses

200

alarm system hook successfully created/updated

400

Passed parameters missing or in wrong format

500

Unexpected database error

put /systemhook/{id}
https://app.groupalarm.com/api/v1/systemhook/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "service": "string",
  • "url": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "success"
}

DeleteSystemhook

Deletes the system hook with the passed id

path Parameters
id
required
int64

id of the systemhook

Responses

200

System hook successfully deleted

400

Passed parameters missing or in wrong format

500

Unexpected database error

delete /systemhook/{id}
https://app.groupalarm.com/api/v1/systemhook/{id}

GetSystemhooks

Returns all system hooks for the passed organization id

query Parameters
organization
required
int64

id of organization

Responses

200

All system hooks for the passed organization

400

Passed parameters missing or in wrong format

500

Unexpected database error

get /systemhooks
https://app.groupalarm.com/api/v1/systemhooks

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

GetSystemhookServicePayloads

Returns all payloads of the usable system hooks

Responses

200

All usable payloads of the implemented services inside the system hook service

400

Passed parameters missing or in wrong format

500

Unexpected database error

get /systemhooks/payloads
https://app.groupalarm.com/api/v1/systemhooks/payloads

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

TestSystemhook

Tests a passed systemhook object against the given url with an example payload for the passed service

Request Body schema: application/json
id
integer <int64>

id of the systemhook

name
required
string

name of the systemhook

organizationID
required
integer <int64>

id of the containing organization

service
required
string

name of the services for this system hook

url
required
string

url of the systemhook

Responses

200

message with the returned statuscode from 3rd party api

400

Passed parameters missing or in wrong format

500

Unexpected database error

post /systemhooks/payloads
https://app.groupalarm.com/api/v1/systemhooks/payloads

Request samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "service": "string",
  • "url": "string"
}