Report Filing Service
| POST | /async/webhooks/subscriptions/{Id}/update |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests;
using PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses;
using ServiceStack.Webhooks.ServiceModel.Types;
namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests
{
///<summary>
///Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.
///</summary>
[Api(Description="Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.")]
public partial class UpdateWebhookSubscriptionAsync
: UpdateWebhookSubscriptionBase
{
}
///<summary>
///Specifies a request to update a webhook subscription specified by its unique identifier.
///</summary>
[Api(Description="Specifies a request to update a webhook subscription specified by its unique identifier.")]
public partial class UpdateWebhookSubscriptionBase
: IPost, IConfigurable
{
///<summary>
///The unique identifier of the subscriber.
///</summary>
[ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")]
public virtual string Id { get; set; }
///<summary>
///The name of the subscription.
///</summary>
[ApiMember(Description="The name of the subscription.", Name="Name")]
public virtual string Name { get; set; }
///<summary>
///The name of the subscribed event.
///</summary>
[ApiMember(Description="The name of the subscribed event.", Name="Event")]
public virtual string Event { get; set; }
///<summary>
///The callback URL to be called when an "event" of a certain type is going to be raised.
///</summary>
[ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", Name="Url")]
public virtual string Url { get; set; }
///<summary>
///The MIME type of content pushed to the recipient service e.g. application/json
///</summary>
[ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")]
public virtual string ContentType { get; set; }
///<summary>
///The current secret that is used to sign and authenticate messages from webhook endpoints.
///</summary>
[ApiMember(Description="The current secret that is used to sign and authenticate messages from webhook endpoints.", IsRequired=true, Name="CurrentSecret")]
public virtual string CurrentSecret { get; set; }
///<summary>
///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.
///</summary>
[ApiMember(Description="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.", Name="NewSecret")]
public virtual string NewSecret { get; set; }
///<summary>
///Indicates whether the subscription is enabled or disabled.
///</summary>
[ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")]
public virtual bool? IsActive { get; set; }
///<summary>
///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.
///</summary>
[ApiMember(Description="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.", IsRequired=true, Name="PublicKeyXml")]
public virtual string PublicKeyXml { get; set; }
}
}
namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses
{
///<summary>
///Represents a service response that encapsulates a webhook subscription.
///</summary>
[Api(Description="Represents a service response that encapsulates a webhook subscription.")]
public partial class SubscriptionResponse
{
public SubscriptionResponse()
{
History = new List<SubscriptionDeliveryResult>{};
}
///<summary>
///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.
///</summary>
[ApiMember(Description="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.", Name="Subscription")]
public virtual WebhookSubscription Subscription { get; set; }
///<summary>
///The history of the subscription event.
///</summary>
[ApiMember(Description="The history of the subscription event.", Name="History")]
public virtual List<SubscriptionDeliveryResult> History { get; set; }
///<summary>
///The status of the response.
///</summary>
[ApiMember(Description="The status of the response.", Name="ResponseStatus")]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
namespace ServiceStack.Webhooks.ServiceModel.Types
{
public partial class SubscriptionConfig
{
public virtual string Url { get; set; }
public virtual string ContentType { get; set; }
public virtual string Secret { get; set; }
}
public partial class SubscriptionDeliveryResult
{
public virtual DateTime AttemptedDateUtc { get; set; }
public virtual string StatusDescription { get; set; }
public virtual HttpStatusCode StatusCode { get; set; }
public virtual string SubscriptionId { get; set; }
public virtual string Id { get; set; }
public virtual string EventId { get; set; }
}
public partial class WebhookSubscription
{
public virtual string Id { get; set; }
public virtual string Name { get; set; }
public virtual string Event { get; set; }
public virtual bool IsActive { get; set; }
public virtual DateTime CreatedDateUtc { get; set; }
public virtual string CreatedById { get; set; }
public virtual DateTime LastModifiedDateUtc { get; set; }
public virtual SubscriptionConfig Config { get; set; }
}
}
C# UpdateWebhookSubscriptionAsync DTOs
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 /async/webhooks/subscriptions/{Id}/update HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
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: 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
}
}
}