JiwaAPI

<back to all web services

WebhooksSubscriptionsPOSTRequest

The following routes are available for this service:
POST/Webhooks/Subscribers/{SubscriberID}/Subscriptions/Adds a Webhook subscription for a subscriber.
WebhooksSubscriptionsPOSTRequest Parameters:
NameParameterData TypeRequiredDescription
SubscriberIDpathstringNo
URLbodystringNo
EventNamebodystringNo
HeadersbodyList<WebhooksSubscriptionHeader>No
WebhooksSubscriptionHeader Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
SY_WebhookSubscription Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
SY_WebhookSubscriber_RecIDformGuidNo
EventNameformstringNo
URLformstringNo
ItemNoformintNo
LastSavedDateTimeformDateTimeNo
RowHashformbyte[]No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Webhooks/Subscribers/{SubscriberID}/Subscriptions/ HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SubscriberID":"String","URL":"String","EventName":"String","Headers":[{"Name":"String","Value":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"EventName":"String","URL":"String","RowHash":"AA=="}