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

NameDescriptionTypeAdditional 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 Payload
NameDescriptionTypeAdditional 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-05-20T14:17:19.2576314+03:00",
    "Data": "sample string 3",
    "FailedRequests": 4,
    "Response": "sample string 5",
    "State": 1,
    "SubscriptionId": "9be339d5-b77e-4984-93a5-ce964a51d08e",
    "WebhookEventPayloadId": "a4a33341-c540-4e59-b70c-acc86bb19e53"
  },
  {
    "Counter": 1,
    "CreatedUtc": "2025-05-20T14:17:19.2576314+03:00",
    "Data": "sample string 3",
    "FailedRequests": 4,
    "Response": "sample string 5",
    "State": 1,
    "SubscriptionId": "9be339d5-b77e-4984-93a5-ce964a51d08e",
    "WebhookEventPayloadId": "a4a33341-c540-4e59-b70c-acc86bb19e53"
  }
]

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-05-20T14:17:19.2576314+03:00</CreatedUtc>
    <Data>sample string 3</Data>
    <FailedRequests>4</FailedRequests>
    <Response>sample string 5</Response>
    <State>Received</State>
    <SubscriptionId>9be339d5-b77e-4984-93a5-ce964a51d08e</SubscriptionId>
    <WebhookEventPayloadId>a4a33341-c540-4e59-b70c-acc86bb19e53</WebhookEventPayloadId>
  </Payload>
  <Payload>
    <Counter>1</Counter>
    <CreatedUtc>2025-05-20T14:17:19.2576314+03:00</CreatedUtc>
    <Data>sample string 3</Data>
    <FailedRequests>4</FailedRequests>
    <Response>sample string 5</Response>
    <State>Received</State>
    <SubscriptionId>9be339d5-b77e-4984-93a5-ce964a51d08e</SubscriptionId>
    <WebhookEventPayloadId>a4a33341-c540-4e59-b70c-acc86bb19e53</WebhookEventPayloadId>
  </Payload>
</ArrayOfPayload>