Get notification event types

Lists available notification events and their descriptions. “All” is a special event that will trigger receipt for all events.

GET /api/v1/notifications/events

Get notification event types

cURL

curl --request GET \
  --url https://api.byblend.com/api/v1/notifications/events \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "name": "Order Created",
    "description": "Triggered when an order is created",
    "event_code": "order.created"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful response with list of notification events

name · string

Readable name of the event

Example:

"Order Created"

description · string

Description of the event

Example:

"Triggered when an order is created"

event_code · string

Dot-separated unique code for the event; or 'all' for all events

Example:

"order.created"