POST webhook

Owned by Bauke Rietveld
Last updated: 17 Jun 2024Version comment
2 min read

A notification sent by a data service provider to a data service consumer in accordance to an existing subscription.

Parties MUST support a POST call to their webhook url to be able to receive notifications from subscriptions

Request

Authorisation

The data service consumer is responsible for determining a suitable authorisation policy for their notifications resources. See Autorisatie for more information.

Parameters

For information about the parameters that are common to the trust framework’s API’s see Generic API Requirements, and for parameters common to all notification methods, see notification object.

Parties MUST validate that the HTTP body of a POST request to a webhook url contains a valid notification object

{ "id" : "not_123", "resource_type" : "notification", "date" : "1663752217", "consumer_id" : "EU.EORI.NL000123456", "provider_id" : "EU.EORI.NL000345678", "subscription_id" : "sub_123", "description" : "Detailed description of the notification", "event" : [ { "id" : "eve_123", "resource_type" : "event", "event_type" : "Modified", "date" : "1663752228", "description" : "Detailed description of the event", "event_data" : "Data record xyz has been modified by zyx } ] }

Responses

Authorisation

The data service provider is responsible for determining a suitable authorisation policy for the response to a sent notification. See Autorisatie for more information. Due to possible non-repudiation requirements for notifications, responses to notifications may require authentication and authorisation

200 OK

Successful, confirmation that the notification has been received

Parties MUST respond with a 200 OK to a successful POST call to a webhook url

Â