Email Notifications

GET /metadata/email_notifications

Arta's email notifications are optional and configurable. You can use email rules and email subscriptions to dictate whether Arta delivers them on your behalf to either internal or external recipients.

The Email Notifications metadata endpoint lists the current notification types and their properties.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Responses

  • • 200 application/json

    A collection of Email Notifications

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • description string

      A long form description

    • optional_recipients array[string]

      The list of configurable recipients for this notification

    • id string

      The ID representing the resource

    • name string

      A brief title for the resource
GET /metadata/email_notifications 
curl \
 -X GET https://api.arta.io/metadata/email_notifications \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
[
  {
    "description": "Delivered when a shipment is confirmed.",
    "optional_recipients": [
      "destination"
    ],
    "id": "booking",
    "name": "Booking Confirmation"
  }
]