API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve event by event id

This method allows you to retrieve a specific event by specifying the EventId. It is designed to facilitate event playbacks for verification and audit purposes.

It offers an optional query parameter locale that returns the event name and description for the specified locale id. Contact support@possiblenow.com with localized names and description for locales you want to use. If the localized name and description is not configured for the specified locale, the API will return the event name and description in your account's default locale. A future update will provide an API for programmatic management of these updates.

All API users must have the Event Data - > View Permission enabled within their User Groups.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Type of the data being sent in the request or the data that is expected in the response. Supports application/json.

Query Parameters

localestring

Path Parameters

clientIdstring

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

eventIdstring

Unique identifier of the event

Response

200
Object
The request was successfully processed.

Response Attributes

EventIdstring

System-generated identifier that uniquely identifies an event.

EventTypestring

Represents the type of action that occured. It's synonymous with an event.

Subjectstring

An allocated field within the event data structure, reserved for advanced event filtering for routing purposes.

Entitystring

Name of the entity associated with the event.

SubscriptionIdinteger
Namestring

Name of the event.

Descriptionstring

Description of the event.

ProfileIdinteger

This is the value that uniquely identifies the profile for which the events are being retrieved.

Dataobject

Data pertaining to a particular event. It is encapsulated as a nested object with its individual key-value pairs within the Events JSON structure.

Show child attributes

OriginalEventTimestring

The date and time when the event occurred.

EventTimestring

The date and time when the event was queued for distribution.

CreateDatestring

The date and time the event was recorded in the system.

CreatedBystring

The name of the user who recorded the event.

400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.

Response Attributes

Messagestring
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?