Deze pagina’s zijn in het engels ten behoeve van mogelijk internationale ontwikkelaars

A webhook url MAY be implemented by the following roles:

Data SERVICE Consumer Data SERVICE BROKER

In order for a data service consumer to subscribe to an event as defined by a data service provider, they must be able to receive notifications containing events via a webhook url. Notifications are only sent for subscriptions with status equal to active (see Lifecycle of a Subscription for more information). Notifications and events are always structured according to the notification, and event objects.

Parties MUST have a webhook url before obtaining a subscription

If a party has a subscription, they MUST support a notification object

Notification object

Parameters		Description

Parameters		Description
`id`	Required	MUST be the unique identifier of the notification.
`resource_type`	Required	MUST be a string representing the object type, equal to `notification`.
`date`	Required	Date and time that the notification was sent, MUST be a UNIX timestamp, following the timestamp conventions.
`consumer_id`	Required	MUST be a unique identifier of the data service consumer as an Organisation ID, containing an EORI or KvK number.
`provider_id`	Required	MUST be a unique identifier of the data service provider as an Organisation ID, containing an EORI or KvK number.
`subscription_id`	Required	MUST be a unique identifier of the subscription under which the event is monitored.
`description`	Optional	MUST contain a human-readable description of the notification as a string.
`event`	Required	MUST be an event object, as defined here, containing data regarding the event which triggered the notification.

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

Event object

Parameters		Description

Parameters		Description
`id`	Required	MUST be the unique identifier of the event.
`resource_type`	Required	String representing the object type, MUST be equal to `event`.
`event_type`	Required	MUST be the label of the type of event that has taken place. Exact values to be defined by a specific data service. For example: `Modified`, `Deleted`, `Moved`, `Created.`
`date`	Required	Date and time that the event took place, MUST be a UNIX timestamp, following the timestamp conventions.
`description`	Optional	MUST contain a human-readable description of the event which triggered the notification as a string.
`event_data`	Optional	MUST contain data related to the event

{
  "id" : "eve_123",
  "resource_type" : "event",
  "event_type" : "Modified",
  "date" : "1663752217",
  "description" : "Detailed description of the event",
  "event_data" : "Data record xyz has been modified by zyx"
}

Webhook

The webhook allows data service consumers to receive and act upon notifications from a data service provider. The webhook should follow the generic technical requirements, as well as the requirements specified for specific methods. Further, data service consumers are responsible for determining a suitable authorisation policy for their notifications. See Autorisatie for more information.

The figure below gives an overview of the HTTP methods that are supported by the webhook url. These methods are further detailed and specified in the pages below:

DSGO v0.9

Webhook url

Notification object

Event object

Webhook