Report Filing Service

<back to all web services

GetWebhookSubscriptionAsync

GetSubscriptionsWebhooksAsync

Represents a request to retrieve a webhook subscription by its unique identifier, and retrieve its details in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
GET/async/webhooks/subscriptions/{Id}
GetWebhookSubscriptionBase Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier of the subscriber.
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 .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

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

GET /async/webhooks/subscriptions/{Id} HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/x-msgpack
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}