APappdirect
Event

Retrieve an event

Changed on

This call returns all details for a specific event.

get/channel/v1/events/{eventId}

Request

Path parameters

eventIdstring required

Only return event with this event id.

Response

Event read.

asynchronousboolean

Whether the event is asynchronous or not

consumedboolean

Whether the event has been consumed by vendor or not

creationDatenumber

Date when the event was created

manuallyResolvedboolean

Whether the event has been manually resolved

orderIdnumber

Order id

subscriptionIdnumber

Subscription id

successfulboolean

If the event is consumed, then whether it's successful or not

type'SUBSCRIPTION_ORDER' | 'SUBSCRIPTION_CHANGE' | 'SUBSCRIPTION_CANCEL' | 'SUBSCRIPTION_NOTICE' | 'USER_ASSIGNMENT' | 'USER_UNASSIGNMENT' | 'USER_UPDATED' | 'ADDON_ORDER' | 'ADDON_CHANGE' | 'ADDON_CANCEL' | 'ADDON_BIND' | 'ADDON_UNBIND'
uuidstring

Unique event identifier

Example response

{
  "asynchronous": true,
  "company": {
    "companyId": "...",
    "links": [
      {
        "href": "...",
        "rel": "..."
      },
      {
        "href": "...",
        "rel": "..."
      }
    ],
    "name": "..."
  },
  "consumed": true,
  "creationDate": 12345,
  "error": {
    "code": "...",
    "message": "..."
  },
  "manuallyResolved": true,
  "orderId": 12345,
  "product": {
    "links": [
      {
        "href": "...",
        "rel": "..."
      },
      {
        "href": "...",
        "rel": "..."
      }
    ],
    "name": "...",
    "productId": 12345
  },
  "subscriptionId": 12345,
  "successful": true,
  "type": "SUBSCRIPTION_CHANGE",
  "uuid": "..."
}

Changes