JiwaAPI

<back to all web services

WebhooksMessagesGETRequest

The following routes are available for this service:
GET/Webhooks/Subscribers/{SubscriberID}/MessagesRetrieves a list of all Webhook messages for a subscriber.
WebhooksMessagesGETRequest Parameters:
NameParameterData TypeRequiredDescription
SubscriberIDpathstringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_SY_WebhookSubscriber_Messages Parameters:
NameParameterData TypeRequiredDescription
SubscriberIDformGuidNo
SubscriptionIDformGuidNo
MessageIDformGuidNo
EventNameformstringNo
URLformstringNo
BodyformstringNo
ItemNoformintNo
StatusformbyteNo
RetriesformintNo
AddedDateTimeformDateTimeNo
LastSavedDateTimeformDateTimeNo
LastMessageResponseHTTPCodeformint?No
LastMessageResponseMessageformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Webhooks/Subscribers/{SubscriberID}/Messages 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","LastMessageResponseHTTPCode":0,"LastMessageResponseMessage":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}