<back to all web services

UpdateWebhookSubscriptionAsync

Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.

/** @description Specifies a request to update a webhook subscription specified by its unique identifier. */
// @Api(Description="Specifies a request to update a webhook subscription specified by its unique identifier.")
export class UpdateWebhookSubscriptionBase implements IPost, IConfigurable
{
    /** @description The unique identifier of the subscriber. */
    // @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
    public id: string;

    /** @description The name of the subscription. */
    // @ApiMember(Description="The name of the subscription.", Name="Name")
    public name: string;

    /** @description The name of the subscribed event. */
    // @ApiMember(Description="The name of the subscribed event.", Name="Event")
    public event: string;

    /** @description The callback URL to be called when an "event" of a certain type is going to be raised. */
    // @ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", Name="Url")
    public url: string;

    /** @description The MIME type of content pushed to the recipient service e.g. application/json */
    // @ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")
    public contentType: string;

    /** @description The current secret that is used to sign and authenticate messages from webhook endpoints. */
    // @ApiMember(Description="The current secret that is used to sign and authenticate messages from webhook endpoints.", IsRequired=true, Name="CurrentSecret")
    public currentSecret: string;

    /** @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. */
    // @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 newSecret: string;

    /** @description Indicates whether the subscription is enabled or disabled. */
    // @ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")
    public isActive?: boolean;

    /** @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. */
    // @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 publicKeyXml: string;

    public constructor(init?: Partial<UpdateWebhookSubscriptionBase>) { (Object as any).assign(this, init); }
}

export class SubscriptionConfig
{
    public url: string;
    public contentType: string;
    public secret: string;

    public constructor(init?: Partial<SubscriptionConfig>) { (Object as any).assign(this, init); }
}

export class WebhookSubscription
{
    public id: string;
    public name: string;
    public event: string;
    public isActive: boolean;
    public createdDateUtc: string;
    public createdById: string;
    public lastModifiedDateUtc: string;
    public config: SubscriptionConfig;

    public constructor(init?: Partial<WebhookSubscription>) { (Object as any).assign(this, init); }
}

export class SubscriptionDeliveryResult
{
    public attemptedDateUtc: string;
    public statusDescription: string;
    public statusCode: HttpStatusCode;
    public subscriptionId: string;
    public id: string;
    public eventId: string;

    public constructor(init?: Partial<SubscriptionDeliveryResult>) { (Object as any).assign(this, init); }
}

/** @description Represents a service response that encapsulates a webhook subscription. */
// @Api(Description="Represents a service response that encapsulates a webhook subscription.")
export class SubscriptionResponse
{
    /** @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. */
    // @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 subscription: WebhookSubscription;

    /** @description The history of the subscription event. */
    // @ApiMember(Description="The history of the subscription event.", Name="History")
    public history: SubscriptionDeliveryResult[];

    /** @description The status of the response. */
    // @ApiMember(Description="The status of the response.", Name="ResponseStatus")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<SubscriptionResponse>) { (Object as any).assign(this, init); }
}

/** @description Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation. */
// @Api(Description="Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.")
export class UpdateWebhookSubscriptionAsync extends UpdateWebhookSubscriptionBase
{

    public constructor(init?: Partial<UpdateWebhookSubscriptionAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UpdateWebhookSubscriptionAsync DTOs

POST /async/webhooks/subscriptions/{Id}/update HTTP/1.1 
Host: reportfiling.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
		}
	}
}