FEAT - Adding the external event types

schemas/README.md

@@ -3,3 +3,5 @@
 JSON schemas that are relevant to the specifications are kept here, and will be listed below.
 
 - Payments NZ SET token for Event Notification [schema](./event-notification-schema.json)
+- Payments NZ Event types which includes the mandatory and optional events agreed upon [schema](./event-types-schema.json)
+

schemas/event-type-schema.json

@@ -0,0 +1,21 @@
+{
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://apicentre.paymentsnz.co.nz/schemas/event-type-schema.json",
+  "title": "The schema for the Event Type string",
+  "type": "string",
+  "anyOf": [
+    {
+      "enum": ["urn:nz:co:paymentsnz:apicentre:events:account-access-consent-revoked", "urn:nz:co:paymentsnz:apicentre:events:enduring-payment-consent-revoked"],
+      "description": "The mandatory event types defined by API Centre. API Providers must support these event types"
+    },
+    {
+      "enum": ["urn:nz:co:paymentsnz:apicentre:events:xyz"],
+      "description": "The optional event types defined by API Centre. If API Providers support these event types, they should use the same Event Type name"
+    },
+    {
+      "type": "string",
+      "description": "Custom event types defined by the API Provider"
+    }
+  ]
+}

schemas/event-types-schema.md

@@ -0,0 +1,20 @@
+# Event Types Schema - `event-type-schema.json`
+
+This schema defines the known event types that are used in the Event Notification API.
+
+This list is maintained alongside the Event Notification API which will also define the mandatory events that must be
+supported by all API Providers. Any changes to the list of mandatory events will require a new version of the standards
+to be published. This list also includes the names of optional events that have been agreed by the API Centre working
+groups. These optional event types can be updated outside of publishing a new standards version.
+
+API Providers can also define their own custom event types, these would be namespaced to the API provider to avoid
+collisions with the standard event types.
+
+This has been split out so that instead of API Providers creating custom event types with different names and the same
+meaning. They can propose a new Optional event type be added to the standard list for all API Providers to use. 
+
+| Event Type                                                               | Mandatory/Optional | Description                                                                                                              |
+|--------------------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------|
+| `urn:nz:co:paymentsnz:apicentre:events:account-access-consent-revoked`   | Mandatory          | Inform the data requestor when an account access consent created by them is revoked by the customer at the data holder   |
+| `urn:nz:co:paymentsnz:apicentre:events:enduring-payment-consent-revoked` | Mandatory          | Inform the data requestor when an enduring payment consent created by them is revoked by the customer at the data holder |
+| `urn:nz:co:paymentsnz:apicentre:events:xyz`                              | Optional           | Example optional event type to show how they would appear in the schema. (will remove this line in future)               |

working/v3.0.2/README.md

@@ -0,0 +1,7 @@
+# Event Notification
+
+## V3.0.2
+
+This is v3.0.2 NZ Open Banking Event Notification API technical specification.  Event Notifications is derived from UK Open Banking Event Notification API v3.1.10, available [here](https://openbankinguk.github.io/read-write-api-site3/v3.1.10/profiles/event-notification-api-profile.html).
+
+The OpenAPI document for this specification is available [here](event-notification-openapi.yaml)