Notifications

Push Notification - Notifies the tenant of the EHF status of documents sent and received on behalf of their customers

Notifications overview

When sending or receiving documents, the transmission status changes based on various events. The status changes occur asynchronously which is why notifications are necessary.

Tenants are notified in situations such as:

• When the document submitted for transmission has been sent successfully or failed

• When their customer receives an inbound EHF

Below, we'll explain how you can receive the notifications.

Push Notifications (Webhooks)

You will be notified through push notifications (webhooks), where we deliver these updates directly to your application. You would need to implement in your ERP or your software application our Webhook API documented using OpenAPI 3 specification.

openapi: 3.0.3
info:
  title: Zirius Accesspoint Webhook Notification
  version: 1.0.0
  description: Webhook to receive status updates for sent and received EHFs.

paths:
  /webhook/notification:
    post:
      summary: Receive invoice status notification
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendInvoiceNotification'
      responses:
        '200':
          description: Notification received successfully

components:
  schemas:
    SendInvoiceNotification:
      type: object
      required:
        - eventType
        - transmissionId
        - jobId
        - status
        - fileReference
      properties:
        eventType:
          type: string
          example: SEND_EHF
        transmissionId:
          type: string
          example: 7ec22637303b11eda7239a0197b30fe2
        jobId:
          type: string
          example: 8ab25635303b11340fe2
        status:
          type: string
          example: SENT
        fileReference:
          type: string
          example: file-reference-key

Let's suppose that you as a Seller send an Invoice to the Buyer and it's successfully received by the receiving Accesspoint, we will push you the following notification by calling your webhook implementation described above:

{
  "eventType": "SEND_INVOICE",
  "transmissionId": "7ec22637303b11eda7239a0197b30fe2",
  "jobId": "8ab25635303b11340fe2"
  "status": "SENT",
  "fileReference": "file-reference-key"
}

We expect your webhook endpoint to return HTTP status 200 OK, indicating that you successfully processed the notification. If a different status code is returned, we will retry delivery every 5 minutes for up to one hour.

NOTE: Please ensure that traffic from our servers is allowed in your firewall rules. We will provide you with the static IP used to call your webhook endpoint.

Notification Status Types

Code	Description
SUBMITTED	Waiting to be sent to the receiver Access Point C3
SENT	Acknowledged by the receiver Access Point C3
FAILED	Failed to send to the receiver's Access Point C3
RECEIVED	Received an inbound EHF successfully from the Seller's Accesspoint

When you receive an EHF from the Seller you will get notified, with the status 'RECEIVED'. This notification contains the fileReference which you will use to download the EHF.