POST api/v1/Webhooks/Subscriptions
Adds new webhook subscription
Request Information
URI Parameters
None.
Body Parameters
AddOrUpdateSubscriptionName | Description | Type | Additional information |
---|---|---|---|
CustomHeader | string |
None. |
|
EndDateUtc | date |
None. |
|
JsonPathFilter | string |
None. |
|
StartDateUtc | date |
None. |
|
SubscriptionId | globally unique identifier |
None. |
|
TargetEndpointUri | string |
None. |
|
WebhookEventId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "CustomHeader": "sample string 1", "EndDateUtc": "2025-05-20T13:56:28.2128401+03:00", "JsonPathFilter": "sample string 3", "StartDateUtc": "2025-05-20T13:56:28.2128401+03:00", "SubscriptionId": "68255a7b-432f-4b4b-8b6b-c9076668ef72", "TargetEndpointUri": "sample string 6", "WebhookEventId": "6e639f33-b2cb-407e-8c32-70901b7e3c0f" }
application/xml, text/xml
Sample:
<AddOrUpdateSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus.webhookservicews.Parameters"> <CustomHeader>sample string 1</CustomHeader> <EndDateUtc>2025-05-20T13:56:28.2128401+03:00</EndDateUtc> <JsonPathFilter>sample string 3</JsonPathFilter> <StartDateUtc>2025-05-20T13:56:28.2128401+03:00</StartDateUtc> <SubscriptionId>68255a7b-432f-4b4b-8b6b-c9076668ef72</SubscriptionId> <TargetEndpointUri>sample string 6</TargetEndpointUri> <WebhookEventId>6e639f33-b2cb-407e-8c32-70901b7e3c0f</WebhookEventId> </AddOrUpdateSubscription>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.