Nash Notifications API is one of 30 APIs that Nash publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Notifications. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.
This API exposes 8 operations across 5 paths, and defines 98 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 4 base URLs: https://api.sandbox.usenash.com, https://api.sandbox.ap-southeast-2.usenash.com, https://api.usenash.com, https://api.ap-southeast-2.usenash.com.
8 operations
5 paths
98 schemas
1 DELETE4 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Nash Notifications API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT, API Key) (Token).
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Notifications 8
Notifications
GET
/v1/notification-triggers
List Notification Triggers
POST
/v1/notification-triggers
Create Notification Trigger
GET
/v1/notification-triggers/catalog
Get Notification Trigger Catalog
GET
/v1/notification-triggers/templates
List Notification Trigger Templates
POST
/v1/notification/{id}/trigger
Trigger Notification
GET
/v1/organization-management/notifications/deny-list
Get contacts in the deny list.
POST
/v1/organization-management/notifications/deny-list
Add a contact to the deny list.
DELETE
/v1/organization-management/notifications/deny-list
Remove a contact from the deny list.
Schemas 98
The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are CreateDriverGeolocationTrigger (15 properties), CreateStatusTriggeredTooEarlyTrigger (15 properties), CreateOptimizationOrderUnassignedTrigger (15 properties), CreateDeliveryCompletedTooEarlyTrigger (15 properties). Each schema is shown below with its type and property counts.
CreateDriverGeolocationTrigger
object
15 properties
4 required
NashErrorDetails
object
3 properties
2 required
CreateDeliveryNoteAddedTrigger
object
15 properties
3 required
CreateDemoTrigger
object
15 properties
3 required
OrderModifiedParams
object
1 property
1 required
DriverGeolocationStoppedForParams
object
8 properties
2 required
StatusTriggeredTooEarlyParams
object
2 properties
2 required
SuccessResponse
object
Representation of a success response.
1 property
1 required
DeliveryIncidentReportParams
object
3 properties
CreateOptimizationActionStatusTrigger
object
15 properties
4 required
DenyList
object
Representation of a Nash deny list.
3 properties
3 required
FilterValueType
string
How a filter criterion's value is shaped.
CreateAiConversationCompletedTrigger
object
15 properties
3 required
CreateDeliveryStatusTransitionTrigger
object
15 properties
4 required
TimeElapsedSinceStatusParams
object
4 properties
2 required
CreateRouteStatusTransitionTrigger
object
15 properties
3 required
TaskReassignmentParams
object
3 properties
2 required
TaskHealthStatusParams
object
2 properties
2 required
InternalDriverNotAssignedParams
object
2 properties
1 required
CreateOrderModifiedTrigger
object
15 properties
3 required
DeliveryCompletedTooEarlyParams
object
1 property
1 required
CreateStuckStatusTrigger
object
15 properties
4 required
CustomEventListenerParams
object
1 property
1 required
DriverStackingParams
object
2 properties
ActivityAction
string
OrderModifiedField
string
Order fields selectable for the ordermodified workflow trigger.
CreateJobCreationFailedTrigger
object
15 properties
3 required
NotificationTriggerOutputSerializer
object
3 properties
2 required
CreateStatusChangedTooQuicklyTrigger
object
15 properties
4 required
ConditionOperator
string
Operators available in a metadata condition tree. Must mirror the operators the runtime evaluator honors in streamingservice/notifications/utils.py (meetscondi…
RouteStatusTransitionParams
object
2 properties
RefundRequestParams
object
1 property
1 required
DeliveryStatusTransitionParams
object
3 properties
1 required
EntityStatus
string
CreateOrderNotDispatchedCloseToPickupTrigger
object
15 properties
4 required
NotificationTriggerCatalogResponse
object
Full catalog response for GET /v1/notification-triggers/catalog.
3 properties
_NoParams
object
Empty parameters object for triggers that take no configuration.
ActivityStatus
string
Status of an activity.
ZoneGeolocationParams
object
1 property
CreateTimingUpdatedTrigger
object
15 properties
3 required
FilterCriterion
object
A single filter criterion available to all notification triggers.
6 properties
2 required
CreateApiBasedTrigger
object
15 properties
3 required
CreateTasksAttemptsExhaustedTrigger
object
15 properties
3 required
NotificationTriggerType
string
CreateCourierUpdatedTrigger
object
15 properties
3 required
NotificationTriggerResponse
object
A notification trigger configured on an organization.
6 properties
4 required
AddContactToDenyListSerializer
object
Expected payload for endpoint assigning role names to a user.
2 properties
2 required
DriverLocationVsDeliveryStatusParams
object
3 properties
2 required
CreateDriverLocationVsDeliveryStatusTrigger
object
15 properties
4 required
DenyListResponse
array
Representation of a deny list response.
NotificationTriggerSlug
string
OptimizationActionStatusParams
object
1 property
1 required
OrderNotDispatchedParams
object
1 property
1 required
CreateTaskHealthStatusTrigger
object
15 properties
4 required
DeliveryWindowBookedTimeoutParams
object
1 property
1 required
StatusesChangedTooQuicklyParams
object
4 properties
3 required
ListNotificationTriggerTemplatesResponse
object
1 property
CreateOrderNeedsAttentionTrigger
object
15 properties
4 required
CreateRefundRequestTrigger
object
15 properties
4 required
CreateInternalDriverNotAssignedTrigger
object
15 properties
4 required
TriggerNotificationInputSerializer
object
1 property
1 required
CreateDeliveryWindowBookedTimeoutTrigger
object
15 properties
4 required
TriggerNotificationOutputSerializer
object
1 property
1 required
CreateAddressValidationFailedTrigger
object
15 properties
3 required
CreateNotificationTriggerInput
Root serializer for POST /v1/notification-triggers. Thin wrapper over the type-discriminated union so flask-openapi3 can consume it as a body type; callers sen…
CreateTaskReassignmentTrigger
object
15 properties
4 required
NotificationTriggerTemplateResponse
object
A pre-defined notification trigger template that can be instantiated for an org.
2 properties
2 required
CreateTimeElapsedSinceStatusTrigger
object
15 properties
4 required
ActionKey
string
The actions a trigger can be configured to take when it fires.
TriggerEntityType
string
Primary entity a trigger relates to.
CreateNashAiInvalidPodTrigger
object
15 properties
3 required
CreateAutodispatchFailedTrigger
object
15 properties
3 required
CreatePickupDelayedTrigger
object
15 properties
4 required
RouteStatus
string
Status enum for Routes.
OrderNeedsAttentionParams
object
1 property
CreateActivityStatusTransitionTrigger
object
15 properties
4 required
CreateZoneGeolocationTrigger
object
15 properties
4 required
ListNotificationTriggersResponse
object
1 property
FilterCriterionKey
string
The shared filter criteria a trigger can be scoped by.
PickupDelayedParams
object
2 properties
1 required
TriggerAction
object
An action type that can be configured on a notification trigger.
2 properties
1 required
DriverGeolocationWithinParams
object
9 properties
3 required
DriverGeolocationGreaterThanParams
object
9 properties
3 required
CreateDropoffDelayedTrigger
object
15 properties
4 required
DropoffDelayedParams
object
2 properties
1 required
CreateOrderReadyToFulfillTrigger
object
15 properties
3 required
CreateDriverStackingTrigger
object
15 properties
4 required
CreateDeliveryCancellationFailedTrigger
object
15 properties
3 required
CreateProofOfDeliveryUploadedTrigger
object
15 properties
3 required
NashValidationError
object
3 properties
3 required
CreateDeliveryIncidentReportTrigger
object
15 properties
4 required
CreateDeliveryCompletedTooEarlyTrigger
object
15 properties
4 required
StuckStatusParams
object
6 properties
2 required
CreateOptimizationOrderUnassignedTrigger
object
15 properties
3 required
CreateStatusTriggeredTooEarlyTrigger
object
15 properties
4 required
TriggerCatalogEntry
object
A single trigger type in the notification trigger catalog.
12 properties
5 required
ActivityStatusTransitionParams
object
2 properties
2 required
CreateCustomEventListenerTrigger
object
15 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nash 12
Other APIs Nash publishes across the network.
Nash AI Functions API
Nash Annotate API
Nash Batch Job API
Nash Contracts API
Nash Couriers API
Nash Delivery Windows API
Nash Dispatch Strategies API
Nash Feedback API
Nash Fleet API
Nash Job API
Nash Messaging API
Nash Miscellaneous API
#Notifications