GET | /Webhooks/Subscribers/{SubscriberID}/Messages/Responses | Retrieves a list of all Webhook messages responses for a subscriber. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SubscriberID | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SubscriberID | form | Guid | No | |
SubscriptionID | form | Guid | No | |
MessageID | form | Guid | No | |
MessageResponseID | form | Guid | No | |
EventName | form | string | No | |
URL | form | string | No | |
Body | form | string | No | |
MessageItemNo | form | int | No | |
Status | form | byte | No | |
Retries | form | int | No | |
AddedDateTime | form | DateTime | No | |
MessageLastSavedDateTime | form | DateTime | No | |
HTTPCode | form | int | No | |
Message | form | string | No | |
ItemNo | form | int | No | |
LastSavedDateTime | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Webhooks/Subscribers/{SubscriberID}/Messages/Responses HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Results":[{"EventName":"String","URL":"String","Body":"String","Message":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}