MESHInboxMessageAcknowledged Data

Data payload of the MESHInboxMessageAcknowledged event

Known Issues / Todo

⛅ This page is draft and is subject to rapid change, and may not be fully accurate or complete

Full Screen

MESHInboxMessageAcknowledged Data

Data payload of the MESHInboxMessageAcknowledged event

Schema Information

Schema ID: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.json
Schema Version: https://json-schema.org/draft/2020-12/schema
Source File: digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml

Properties

`messageReference`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageReference

`senderId`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId

`meshMailboxId`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/meshMailboxId

`receivedMeshMessageId`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/meshMessageId

`sentMeshMessageId`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/meshMessageId

`statusCode`

Type: integer

HTTP status code indicating the result of the acknowledgement (202 for success, 400 for failure)

Allowed values: 202, 400

`failureCode`

Type: string

Failure code indicating the reason for a negative acknowledgement

Required Fields

senderId
meshMailboxId
receivedMeshMessageId
sentMeshMessageId
statusCode

Additional Properties

Additional properties are not allowed.

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: MESHInboxMessageAcknowledged Data
description: Data payload of the MESHInboxMessageAcknowledged event
type: object
additionalProperties: false
properties:
  messageReference:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageReference
  senderId:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId
  meshMailboxId:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/meshMailboxId
  receivedMeshMessageId:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/meshMessageId
  sentMeshMessageId:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/meshMessageId
  statusCode:
    type: integer
    description: HTTP status code indicating the result of the acknowledgement (202
      for success, 400 for failure)
    enum:
    - 202
    - 400
  failureCode:
    type: string
    description: Failure code indicating the reason for a negative acknowledgement
required:
- senderId
- meshMailboxId
- receivedMeshMessageId
- sentMeshMessageId
- statusCode