List a subscriber's subscriptions

GET

api

webhook

subscribers

{subscriberId}

subscriptions

List a subscriber's subscriptions

curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/webhook/subscribers/{subscriberId}/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "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

subscriberId

integer<int32>

required

Response

List of subscriptions

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

Update a subscriberActivates/deactivates a subscriber or rotates its `secretToken`. When `rotateSecretToken` is `true`, the response contains the new token — the previous token will no longer validate signatures.

List a subscriber's subscriptions

curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/webhook/subscribers/{subscriberId}/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "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>"
    }
  ]
}