Webhooks

Manage a single webhook subscription for real-time alert events (subscribe/update, status, delete).

Get alerts webhook subscription status

get

Returns the current subscription status or none if not configured.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Status payload

application/json

urlstringOptional

statusstring · enumOptionalPossible values:

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

secretstring · nullableOptional

Returned only when a new secret is generated or explicitly updated

401

Unauthorized

application/json

500

Unexpected server error

application/json

503

Service temporarily unavailable

application/json

get

/webhooks/subscription

HTTPcURLJavaScriptPython

GET /v1/webhooks/subscription HTTP/1.1
Host: api.fortisx.fi
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://example.com/webhooks/fortisx",
  "status": "active",
  "createdAt": "2022-10-01 13:00:00",
  "updatedAt": "2022-10-01 13:00:00"
}

Upsert alerts webhook subscription

put

Creates or updates the single subscription for alert events.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

urlstring · uriRequired

HTTPS callback URL

secretstringOptional

Optional secret used for HMAC signatures

Responses

200

Subscription is active

application/json

urlstringOptional

statusstring · enumOptionalPossible values:

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

secretstring · nullableOptional

Returned only when a new secret is generated or explicitly updated

400

Invalid parameter

application/json

401

Unauthorized

application/json

500

Unexpected server error

application/json

503

Service temporarily unavailable

application/json

put

/webhooks/subscription

HTTPcURLJavaScriptPython

PUT /v1/webhooks/subscription HTTP/1.1
Host: api.fortisx.fi
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "url": "https://example.com/webhooks/fortisx",
  "secret": "your-secret"
}

{
  "url": "https://example.com/webhooks/fortisx",
  "status": "active",
  "createdAt": "2022-10-01 13:00:00",
  "updatedAt": "2022-10-01 13:00:00",
  "secret": "only-returned-here-if-generated-or-updated"
}

Delete alerts webhook subscription

delete

Removes the current subscription (if any).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

204

Subscription deleted (or none existed)

401

Unauthorized

application/json

500

Unexpected server error

application/json

503

Service temporarily unavailable

application/json

delete

/webhooks/subscription

HTTPcURLJavaScriptPython

DELETE /v1/webhooks/subscription HTTP/1.1
Host: api.fortisx.fi
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content