| Attribute Name | Description |
|---|---|
| content_type | Defines the content_type that the webhook of the ECA would like to receive. The Event Hub currently supports "application/json" and "application/xml". |
| count | Tells the Event Hub how many events to return when invoking the Retrieve Events API. Defaults to 1. |
| description | A free-format string. |
| dispatch_id | The Event Hub assigns a GUID when an event is sent to a specific Event Consuming Application (ECA). |
| domain | Free-format string that names the domain. For example, "edu.byu" or "org.lds" would be valid domain names. Lower case names with no special characters except . are recommended, but not enforced. By convention they are hierarchal with the largest item on the left and getting decreasingly smaller to the right which is why edu.byu is preferred over byu.edu. Domains are intended to be large groupings. There will only ever be a handfull of domains most likely. |
| eca_identity_id | The identity_id for an Event Consuming Application. This is currently the person_id for the non-person entity associated with the ECA's API Key. The eca_identity_id is used to define the queue in Rabbit-MQ and is used to secure maintenance functions on the ECA's webhook. |
| eca_identity_name | The ECA's surname as defined in the non-person entity stored in the PRO system. |
| endpoint | The URL to which the Event Hub will "push" events. Each Event Consuming Application (ECA) is allowed to register one push with the Webhook API. |
| entity | Free-format string that names an entity that raises events. The entity is equivalent to the Event Generating Application (EGA). For example, the MyMap application raises "Add Class" events. Once an entity is defined to the Event Hub, the Event Hub will ensure that the entity can't be impersonated. It does this by forcing the EGA to authenticate when it raises an event and verifying that the authenticated person_id matches the entity_ega. |
| entity_ega | This is the person_id that an Event Generating Application (EGA) will use when it raises events. It is used to verify that EGA can't be impersonated. |
| error_data | When it makes sense, the Event Hub will return the data values in the request that produced the error. |
| event_dt | The Event Hub will record the date/time that the event was received by the Event Hub. |
| event_id | The Event Hub assigns a GUID for each event received by the Event Hub. |
| event_type | Free-format string that names the Event Type. Event Types are potentially cross cutting. I.e., multiple entities (EGAs) could have the same event type. For example, multiple systems like AIM, HR, ITMS, etc could raise an event with an event type of "Email Address Updated". |
| explanation | An application specific explanation of the error. It should correspond to the general HTTP error code returned in the return_code attribute. |
| filter_name | An attribute name that can be used to filter the Event Type in a subscription. For example, if it is possible to filter the "Add Class" events by "teaching_area", then "teaching_area" should be listed as a filter_name when defining the "Add Class" Event Type. |
| filter_value | The data value that can be used for filtering purposes. See filter_name. |
| identity_id | The person_id of the Event Consuming Application (ECA). |
| identity_name | The name associated with the person_id of the Event Consuming Application (ECA). |
| push_option | Each Event Consuming Application (ECA) is allowed to specify if it wishes to have Event Messages pushed to them (Push Message) or if it simply wishes to be alerted (Push Alert) that the Event Hub has messages to which it has subscribed. |
| return_code | Contains the HTTP error code. |
| security_key | If the Event Consuming Application (ECA) opts for security, an encryption key is required. |
| security_option | The Event Hub can provide a digest of the Event Message so that the Event Consuming Application (ECA) has an assurance that the Event Message was sent from the Event Hub. |
| source_dt | The Event Generating Application (EGA) is allowed to supply the date/time for the business transaction that caused the event. |
| source_id | The Event Generating Application (EGA) is allowed to supply a reference that links back to the business transaction in the EGA. |
