...
Excerpt |
---|
|
Panel |
---|
panelIconId | 2705 |
---|
panelIcon | :white_check_mark: |
---|
panelIconText | ✅ |
---|
bgColor | #FFF0B3 |
---|
| Data service consumers Parties MUST support a POST call to a /notifications endpoint their webhook url to be able to receive notifications from data service providerssubscriptions |
|
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 /notifications notification object.
Excerpt |
---|
|
Panel |
---|
panelIconId | 2705 |
---|
panelIcon | :white_check_mark: |
---|
panelIconText | ✅ |
---|
bgColor | #FFF0B3 |
---|
| Data service consumers Parties MUST validate that the HTTP body of a POST request to a /notifications endpoint webhook url contains a valid notification object |
|
Expand |
---|
title | Example request body for a POST /notifications call to a webhook url |
---|
|
Code Block |
---|
| {
"id" : "not_123",
"resource_type" : "notification",
"date" : "2022-09-21T10:23:48Z1663752217",
"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" : "2022-09-21T10:23:37Z1663752228",
"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
Excerpt |
---|
|
Panel |
---|
panelIconId | 2705 |
---|
panelIcon | :white_check_mark: |
---|
panelIconText | ✅ |
---|
bgColor | #FFF0B3 |
---|
| Data service consumer Parties MUST respond with a 200 OK to a successful POST call to a /notification endpointwebhook url |
|