Update a subscription

PUT

api

webhook

subscriptions

{id}

Update a subscription

curl --request PUT \
  --url https://gateway-api.guardhousehq.com/api/webhook/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uri": "<string>",
  "isActive": true
}
'

{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": {
    "id": 123,
    "webhookSubscriberEventFilterId": 123,
    "uri": "<string>",
    "isActive": true,
    "createdDateTime": "2023-11-07T05:31:56Z",
    "modifiedDateTime": "2023-11-07T05:31:56Z"
  },
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

integer<int32>

required

Body

application/json

uri

string<uri> | null

isActive

boolean | null

Response

Subscription updated

The standard envelope for every JSON endpoint.

status

object

Show child attributes

data

object

Endpoint-specific payload. null when an error occurred.

Show child attributes

count

integer<int32> | null

message

string

errors

object[]

Show child attributes

List login audit eventsReturns login audit events for the caller's company, newest first. > **Special-scope key required.** This endpoint is gated by the `login-audits.read` entitlement. Your API key must be issued with that scope or the request will be rejected with `403 Forbidden`. Contact Guardhouse Support to have the scope added to an existing key. **Tenant scope:** the company is taken from your access token's `CompanyId` claim. Passing `companyId` in the query string is ignored — cross-tenant isolation is enforced server-side. Results are ordered by `occurredUtc` descending and paged with `Skip((page - 1) * pageSize).Take(pageSize)`. There is no `totalCount` field — when fewer than `pageSize` rows are returned, you have reached the end.

Update a subscription

curl --request PUT \
  --url https://gateway-api.guardhousehq.com/api/webhook/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uri": "<string>",
  "isActive": true
}
'

{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": {
    "id": 123,
    "webhookSubscriberEventFilterId": 123,
    "uri": "<string>",
    "isActive": true,
    "createdDateTime": "2023-11-07T05:31:56Z",
    "modifiedDateTime": "2023-11-07T05:31:56Z"
  },
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ]
}