Create a webhook subscriber

POST

api

webhook

subscribers

Create a webhook subscriber

curl --request POST \
  --url https://gateway-api.guardhousehq.com/api/webhook/subscribers \
  --header 'Authorization: Bearer <token>'

{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": {
    "id": 123,
    "companyId": 123,
    "secretToken": "<string>",
    "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>.

Response

Subscriber created

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

Create an event subscriptionSubscribes a delivery URI to a specific event/eventType pair. See the [Webhooks guide](/api-reference/webhooks) for the full event catalog.

Create a webhook subscriber

curl --request POST \
  --url https://gateway-api.guardhousehq.com/api/webhook/subscribers \
  --header 'Authorization: Bearer <token>'

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