Report Filing Service
| POST | /sync/webhooks/subscriptions/{Id}/update |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | The unique identifier of the subscriber. |
| Name | form | string | No | The name of the subscription. |
| Event | form | string | No | The name of the subscribed event. |
| Url | form | string | No | The callback URL to be called when an "event" of a certain type is going to be raised. |
| ContentType | form | string | No | The MIME type of content pushed to the recipient service e.g. application/json |
| CurrentSecret | form | string | Yes | The current secret that is used to sign and authenticate messages from webhook endpoints. |
| NewSecret | form | string | No | A random Base64-encoded secret key (8 or more characters) to sign and authenticate messages from webhook endpoints. .When receiving a webhook event in your subscribers service, calculate the HMAC signature of the request body using this secret. Compare the calculated signature with the signature included in the "X-Hub-Signature" header of the web hook event. If the signatures do not match, then disregard it, and don't process the request any further. |
| IsActive | form | bool? | No | Indicates whether the subscription is enabled or disabled. |
| PublicKeyXml | form | string | Yes | The XML-encoded RSA public key to encrypt the new secret of the webhook subscription. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted secret with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding. |
| 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. |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Url | form | string | No | |
| ContentType | form | string | No | |
| Secret | form | string | No |
| 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 .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/webhooks/subscriptions/{Id}/update HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"id":"String","name":"String","event":"String","url":"String","contentType":"String","currentSecret":"String","newSecret":"String","isActive":false,"publicKeyXml":"String"}
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"}}}