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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<WebhooksSubscriptionsPOSTRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_EventName_x003E_k__BackingField>String</_x003C_EventName_x003E_k__BackingField>
  <_x003C_Headers_x003E_k__BackingField>
    <WebhooksSubscriptionHeader>
      <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField>String</_x003C_Value_x003E_k__BackingField>
    </WebhooksSubscriptionHeader>
  </_x003C_Headers_x003E_k__BackingField>
  <_x003C_SubscriberID_x003E_k__BackingField>String</_x003C_SubscriberID_x003E_k__BackingField>
  <_x003C_URL_x003E_k__BackingField>String</_x003C_URL_x003E_k__BackingField>
</WebhooksSubscriptionsPOSTRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SY_WebhookSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <_x003C_EventName_x003E_k__BackingField>String</_x003C_EventName_x003E_k__BackingField>
  <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_RecID_x003E_k__BackingField>
  <_x003C_RowHash_x003E_k__BackingField>AA==</_x003C_RowHash_x003E_k__BackingField>
  <_x003C_SY_WebhookSubscriber_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_SY_WebhookSubscriber_RecID_x003E_k__BackingField>
  <_x003C_URL_x003E_k__BackingField>String</_x003C_URL_x003E_k__BackingField>
</SY_WebhookSubscription>