GET api/v1/Webhooks/Subscriptions

Gets webhook subscriptions

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of webhook subscriptions

Collection of 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:19:46.4417053+03:00",
    "JsonPathFilter": "sample string 4",
    "SignKey": "sample string 5",
    "StartDateUtc": "2025-05-20T14:19:46.4417053+03:00",
    "State": 1,
    "SubscriptionId": "8253dff8-6a72-46bf-9bf5-9f3deb410049",
    "TargetEndpointUri": "sample string 8",
    "WebhookEventId": "a07fc548-5a95-4c52-9a2b-dcf420a000ee"
  },
  {
    "Counter": 1,
    "CustomHeader": "sample string 2",
    "EndDateUtc": "2025-05-20T14:19:46.4417053+03:00",
    "JsonPathFilter": "sample string 4",
    "SignKey": "sample string 5",
    "StartDateUtc": "2025-05-20T14:19:46.4417053+03:00",
    "State": 1,
    "SubscriptionId": "8253dff8-6a72-46bf-9bf5-9f3deb410049",
    "TargetEndpointUri": "sample string 8",
    "WebhookEventId": "a07fc548-5a95-4c52-9a2b-dcf420a000ee"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus.webhookservicews.Responses">
  <Subscription>
    <Counter>1</Counter>
    <CustomHeader>sample string 2</CustomHeader>
    <EndDateUtc>2025-05-20T14:19:46.4417053+03:00</EndDateUtc>
    <JsonPathFilter>sample string 4</JsonPathFilter>
    <SignKey>sample string 5</SignKey>
    <StartDateUtc>2025-05-20T14:19:46.4417053+03:00</StartDateUtc>
    <State>Active</State>
    <SubscriptionId>8253dff8-6a72-46bf-9bf5-9f3deb410049</SubscriptionId>
    <TargetEndpointUri>sample string 8</TargetEndpointUri>
    <WebhookEventId>a07fc548-5a95-4c52-9a2b-dcf420a000ee</WebhookEventId>
  </Subscription>
  <Subscription>
    <Counter>1</Counter>
    <CustomHeader>sample string 2</CustomHeader>
    <EndDateUtc>2025-05-20T14:19:46.4417053+03:00</EndDateUtc>
    <JsonPathFilter>sample string 4</JsonPathFilter>
    <SignKey>sample string 5</SignKey>
    <StartDateUtc>2025-05-20T14:19:46.4417053+03:00</StartDateUtc>
    <State>Active</State>
    <SubscriptionId>8253dff8-6a72-46bf-9bf5-9f3deb410049</SubscriptionId>
    <TargetEndpointUri>sample string 8</TargetEndpointUri>
    <WebhookEventId>a07fc548-5a95-4c52-9a2b-dcf420a000ee</WebhookEventId>
  </Subscription>
</ArrayOfSubscription>