POST | /sync/webhooks/subscriptions/{Id}/delete |
---|
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. |
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 .jsv suffix or ?format=jsv
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.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
secret: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { subscription: { id: String, name: String, event: String, isActive: False, createdDateUtc: 0001-01-01, createdById: String, lastModifiedDateUtc: 0001-01-01, config: { url: String, contentType: String, secret: String } }, history: [ { attemptedDateUtc: 0001-01-01, 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 } } }