<back to all web services
DeleteWebhookSubscription
DeleteSubscriptionsWebhooksSync
Represents a request to delete a webhook subscription.
The following routes are available for this service:POST | /sync/webhooks/subscriptions/{Id}/delete | | |
---|
DeleteWebhookSubscriptionBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | string | Yes | The unique identifier of the subscriber. |
Secret | form | string | Yes | The secret of the to-be-deleted webhook subscription. This secret is used to authenticate the owner of the webhook subscription. |
SubscriptionResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
Subscription | form | WebhookSubscription | No | The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key. |
History | form | List<SubscriptionDeliveryResult> | No | The history of the subscription event. |
ResponseStatus | form | ResponseStatus | No | The status of the response. |
WebhookSubscription Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | string | No | |
Name | form | string | No | |
Event | form | string | No | |
IsActive | form | bool | No | |
CreatedDateUtc | form | DateTime | No | |
CreatedById | form | string | No | |
LastModifiedDateUtc | form | DateTime | No | |
Config | form | SubscriptionConfig | No | |
SubscriptionConfig Parameters:Name | Parameter | Data Type | Required | Description |
---|
Url | form | string | No | |
ContentType | form | string | No | |
Secret | form | string | No | |
SubscriptionDeliveryResult Parameters:Name | Parameter | Data Type | Required | Description |
---|
AttemptedDateUtc | form | DateTime | No | |
StatusDescription | form | string | No | |
StatusCode | form | HttpStatusCode | No | |
SubscriptionId | form | string | No | |
Id | form | string | No | |
EventId | form | string | 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 /sync/webhooks/subscriptions/{Id}/delete HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DeleteWebhookSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests">
<Id>String</Id>
<Secret>String</Secret>
</DeleteWebhookSubscription>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses">
<History xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
<d2p1:SubscriptionDeliveryResult>
<d2p1:AttemptedDateUtc>0001-01-01T00:00:00</d2p1:AttemptedDateUtc>
<d2p1:EventId>String</d2p1:EventId>
<d2p1:Id>String</d2p1:Id>
<d2p1:StatusCode>Continue</d2p1:StatusCode>
<d2p1:StatusDescription>String</d2p1:StatusDescription>
<d2p1:SubscriptionId>String</d2p1:SubscriptionId>
</d2p1:SubscriptionDeliveryResult>
</History>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Subscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
<d2p1:Config>
<d2p1:ContentType>String</d2p1:ContentType>
<d2p1:Secret>String</d2p1:Secret>
<d2p1:Url>String</d2p1:Url>
</d2p1:Config>
<d2p1:CreatedById>String</d2p1:CreatedById>
<d2p1:CreatedDateUtc>0001-01-01T00:00:00</d2p1:CreatedDateUtc>
<d2p1:Event>String</d2p1:Event>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsActive>false</d2p1:IsActive>
<d2p1:LastModifiedDateUtc>0001-01-01T00:00:00</d2p1:LastModifiedDateUtc>
<d2p1:Name>String</d2p1:Name>
</Subscription>
</SubscriptionResponse>