API Reference

Generic Notification - event

post
http://localhost:8080/api/hay/v1/communications/notification

This endpoint will receive the main notification stream for the platform events in a new generic format.

Body Params

Details of event the v1 notification

uuid
required

Idempotency key (UUID) to uniquely represent this request and prevent duplication.

string
enum
required

The type of the notification event - one of:

  • BATCH_COMPLETED: The bulk batch-completed event
Allowed:
date-time

Resolution requested by date and time

string
enum

The party responsible for the triggering of an action resulting in a notification event. Possible values:

  • CLIENT: Client executed an action which triggered the event.
  • PLATFORM: Shaype executed an action which triggered the event.
Allowed:
eventDetails

Provided event details.

Responses
200

Success

403

Unauthorised

422

Invalid Input

500

Internal error

Updated 11 months ago

Language
LoadingLoading…

Updated 11 months ago