Sign in
Events

Get a single event by ID.

get/{spaceId}/events/{id}

Path parameters

spaceIdstring required

The ID of the space containing the resource(s).

idstring required

The ID of the event

Response

The requested event

ApiKeyHintstring

Gets or sets the obfuscated hint of the API key used to authenticate the request, if applicable.

ApiKeyIdstring

Gets or sets the ID of the API key used to authenticate the request, if applicable.

Categorystring

Gets or sets the event category.

Commentsstring

Gets or sets any user-provided comments that were recorded with the event.

Detailsstring

Gets or sets the details of the event. For events representing a modification to a document use the ChangeDetails property.

Idstring

Gets or sets a unique identifier for this resource.

IdentityEstablishedWithstring

Gets or sets a description of how the user performing the event identified themselves to Octopus.

IpAddressstring

The IP address of the user that created the event.

IsServiceboolean

Gets or sets whether the user who created the event is a service user or an interactive user.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Messagestring

Gets or sets the message text that summarizes the event.

MessageHtmlstring

Gets or sets the message text that summarizes the event, HTML formatted with links to the related documents.

Occurredstring date-time

Gets or sets the date/time that the event took place.

RelatedDocumentIdsstring[]

Gets or sets a collection of document ID's that this event relates to. Note that the document ID's may no longer exist.

SpaceIdstring

Gets or sets the SpaceId of the event. This represents the space in which the event was raised.

UserAgentstring

Gets or sets the user agent header value from the request that triggered the event

UserIdstring

Gets or sets the ID of the user who created the event.

Usernamestring

Gets or sets the name of the user who created the event.

Example response

{
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this endpoint across all 7 revisions of this API.