Skip to main content
POST
Create an event subscription

Authorizations

Authorization
string
header
required

JWT issued by POST /api/external/token/request. Send as Authorization: Bearer <token>.

external-gh-apim-sub-key
string
header
required

Guardhouse API Management subscription key. Required on every request. The same value is used by all API consumers within a region — contact Guardhouse Support for the subscription key.

Body

application/json
subscriberId
integer<int32>
required
event
enum<string>
required
Available options:
approve,
reject,
submit
eventType
enum<string>
required
Available options:
incidentreport,
timesheet
uri
string<uri>
required

HTTPS URL Guardhouse will POST notifications to.

Response

Subscription created

The standard envelope for every JSON endpoint.

status
object
data
object

Endpoint-specific payload. null when an error occurred.

count
integer<int32> | null
message
string
errors
object[]