Report Filing Service

FindWebhookSubscription

RetrieveSubscriptionsWebhooksSync

Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.

The following routes are available for this service:
GET	/sync/webhooks/subscriptions/find

**FindWebhookSubscriptionBase** Parameters:
Name	Parameter	Data Type	Required	Description
AuthSteuernummer	form	string	Yes	The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
AccountId	form	string	Yes	The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
EventName	form	string	Yes	The unique identifier of the subscriber.

**SubscriptionResponse** Parameters:
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.

**WebhookSubscription** Parameters:
Name	Parameter	Data Type	Required
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

**SubscriptionConfig** Parameters:
Name	Parameter	Data Type	Required
Url	form	string	No
ContentType	form	string	No
Secret	form	string	No

**SubscriptionDeliveryResult** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + JSV

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

GET /sync/webhooks/subscriptions/find HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv

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
		}
	}
}