GET api/v1/Webhooks/Subscriptions/{id}

Gets webhook subscription information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Webhook subscription information

Subscription
NameDescriptionTypeAdditional information
Counter

integer

None.

CustomHeader

string

None.

EndDateUtc

date

None.

JsonPathFilter

string

None.

SignKey

string

None.

StartDateUtc

date

None.

State

SubscriptionState

None.

SubscriptionId

globally unique identifier

None.

TargetEndpointUri

string

None.

WebhookEventId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "Counter": 1,
  "CustomHeader": "sample string 2",
  "EndDateUtc": "2025-05-20T14:23:25.3248196+03:00",
  "JsonPathFilter": "sample string 4",
  "SignKey": "sample string 5",
  "StartDateUtc": "2025-05-20T14:23:25.3248196+03:00",
  "State": 1,
  "SubscriptionId": "d42029be-8110-4e3d-afab-95c52f61895f",
  "TargetEndpointUri": "sample string 8",
  "WebhookEventId": "132bc4dd-8ac9-442a-b02d-4a7c768683b7"
}

application/xml, text/xml

Sample:
<Subscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus.webhookservicews.Responses">
  <Counter>1</Counter>
  <CustomHeader>sample string 2</CustomHeader>
  <EndDateUtc>2025-05-20T14:23:25.3248196+03:00</EndDateUtc>
  <JsonPathFilter>sample string 4</JsonPathFilter>
  <SignKey>sample string 5</SignKey>
  <StartDateUtc>2025-05-20T14:23:25.3248196+03:00</StartDateUtc>
  <State>Active</State>
  <SubscriptionId>d42029be-8110-4e3d-afab-95c52f61895f</SubscriptionId>
  <TargetEndpointUri>sample string 8</TargetEndpointUri>
  <WebhookEventId>132bc4dd-8ac9-442a-b02d-4a7c768683b7</WebhookEventId>
</Subscription>