List Notification Events

Resource:
/api/notification-events
Method:
GET

Returns a list of all notification events a user can subscribe to.

Return Codes

Status Code Comments
Success 200 Successful request
Bad Request 400  
Unauthorized 401

The request did not

pass authentication or

the customer is not a

member of an enterprise

site.

Response Body

The response body includes a list of notification event names and their supported methods.

Property Type Comments
EventType
Container

Container of Event Type

information

EventType

.EventName
String

Name of event that can be

subscribed to.

EventType

.NotificationMethods
Container

Container of Notification

Method information

EventType

.NotificationMethods

.NotificationMethod

String

Name of method that can be

used to send notification

Response Example

<EventTypes>
  <EventType>
    <EventName>quote-ready</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
      <NotificationMethod>http-post</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>project-complete</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
      <NotificationMethod>http-post</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>quote-paid</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
      <NotificationMethod>http-post</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>project-delay</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>approved-bml-transaction</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>submit-for-quoting</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>quote-request-approval</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>review-complete</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>target-locale-complete</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>review-ready</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>rejected-bml-transaction</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>trans-review-complete</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>project-pending</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>midway</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>post-processing-failure</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>notify-owner-change</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>notify-owner-bml-order</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>cancel-project</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>send-invoice</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>deadline-passed</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
  <EventType>
    <EventName>retention-reminder</EventName>
    <NotificationMethods>
      <NotificationMethod>email</NotificationMethod>
    </NotificationMethods>
  </EventType>
</EventTypes>