Report Filing Service

<back to all web services

DeleteWebhookSubscription

DeleteSubscriptionsWebhooksSync

Represents a request to delete a webhook subscription.

Requires Authentication
The following routes are available for this service:
POST/sync/webhooks/subscriptions/{Id}/delete
DeleteWebhookSubscriptionBase Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier of the subscriber.
SecretformstringYesThe secret of the to-be-deleted webhook subscription. This secret is used to authenticate the owner of the webhook subscription.
SubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
SubscriptionformWebhookSubscriptionNoThe 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.
HistoryformList<SubscriptionDeliveryResult>NoThe history of the subscription event.
ResponseStatusformResponseStatusNoThe status of the response.
WebhookSubscription Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
EventformstringNo
IsActiveformboolNo
CreatedDateUtcformDateTimeNo
CreatedByIdformstringNo
LastModifiedDateUtcformDateTimeNo
ConfigformSubscriptionConfigNo
SubscriptionConfig Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
ContentTypeformstringNo
SecretformstringNo
SubscriptionDeliveryResult Parameters:
NameParameterData TypeRequiredDescription
AttemptedDateUtcformDateTimeNo
StatusDescriptionformstringNo
StatusCodeformHttpStatusCodeNo
SubscriptionIdformstringNo
IdformstringNo
EventIdformstringNo

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 /sync/webhooks/subscriptions/{Id}/delete HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","secret":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"subscription":{"id":"String","name":"String","event":"String","isActive":false,"createdDateUtc":"\/Date(-62135596800000-0000)\/","createdById":"String","lastModifiedDateUtc":"\/Date(-62135596800000-0000)\/","config":{"url":"String","contentType":"String","secret":"String"}},"history":[{"attemptedDateUtc":"\/Date(-62135596800000-0000)\/","statusDescription":"String","statusCode":"Continue","subscriptionId":"String","id":"String","eventId":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}