GET api/v1/Webhooks/Subscriptions/{id}/Payloads?state={state}
Gets payloads which have the given state. Returns most recent, maximum of 1000 payloads.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
|
state | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
List of sent payloads with given type and subscription
Collection of PayloadName | Description | Type | Additional information |
---|---|---|---|
Counter | integer |
None. |
|
CreatedUtc | date |
None. |
|
Data | string |
None. |
|
FailedRequests | integer |
None. |
|
Response | string |
None. |
|
State | EventState |
None. |
|
SubscriptionId | globally unique identifier |
None. |
|
WebhookEventPayloadId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Counter": 1, "CreatedUtc": "2025-07-06T02:03:28.6097735+03:00", "Data": "sample string 3", "FailedRequests": 4, "Response": "sample string 5", "State": 1, "SubscriptionId": "172cc8c3-74f9-4516-b788-55bac394c453", "WebhookEventPayloadId": "0d3537ea-0308-45c3-a48e-2dd1ec9ed821" }, { "Counter": 1, "CreatedUtc": "2025-07-06T02:03:28.6097735+03:00", "Data": "sample string 3", "FailedRequests": 4, "Response": "sample string 5", "State": 1, "SubscriptionId": "172cc8c3-74f9-4516-b788-55bac394c453", "WebhookEventPayloadId": "0d3537ea-0308-45c3-a48e-2dd1ec9ed821" } ]
application/xml, text/xml
Sample:
<ArrayOfPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus.webhookservicews.Responses"> <Payload> <Counter>1</Counter> <CreatedUtc>2025-07-06T02:03:28.6097735+03:00</CreatedUtc> <Data>sample string 3</Data> <FailedRequests>4</FailedRequests> <Response>sample string 5</Response> <State>Received</State> <SubscriptionId>172cc8c3-74f9-4516-b788-55bac394c453</SubscriptionId> <WebhookEventPayloadId>0d3537ea-0308-45c3-a48e-2dd1ec9ed821</WebhookEventPayloadId> </Payload> <Payload> <Counter>1</Counter> <CreatedUtc>2025-07-06T02:03:28.6097735+03:00</CreatedUtc> <Data>sample string 3</Data> <FailedRequests>4</FailedRequests> <Response>sample string 5</Response> <State>Received</State> <SubscriptionId>172cc8c3-74f9-4516-b788-55bac394c453</SubscriptionId> <WebhookEventPayloadId>0d3537ea-0308-45c3-a48e-2dd1ec9ed821</WebhookEventPayloadId> </Payload> </ArrayOfPayload>