Retrieve a rules engine timeline message

Retrieves a rules engine timeline message with specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string

Type of event.

messageId
required
string

ID of the rules engine timeline message.

Responses
200

Rules engine message retrieved.

Response Schema: application/json
id
string <= 50 characters

ID of the timeline message.

type
string

Type of timeline message.

Enum: "timeline-comment-created" "ruleset-created" "ruleset-changed"
triggeredBy
string

Specifies who, or what, triggered the timeline event.

Enum: "rebilly" "app" "direct-api"
message
string

Contents of the timeline message.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available for a timeline message. If no actions are available, this field is empty.

Array (>= 0 items)
action
string
redemptionId
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

Array of objects (TimelineTable) >= 0 items

Table data that is attached to the timeline message.

Array (>= 0 items)
type
string
title
string

Data table title.

footer
string

Data table footer.

Array of objects

Table data. Each array element represents a table row.

object

Author of the timeline message.

userFullName
string

Author's full name.

userId
string

Author's user ID.

object

User mentions, or tags, in a timeline.

property name*
additional property
string
Array of objects

Links that are attached to a timeline message.

Array
resourceType
string
Enum: "kyc-document" "invoice" "subscription" "transaction" "email-message" "dispute" "coupon" "external"
resourceId
string (ResourceId) <= 50 characters

Unique resource ID. Defaults to UUID v4.

placeholder
string
externalUrl
string
occurredTime
string <date-time>

Date and time when the timeline message occurred.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/events/{eventType}/timeline/{messageId}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "timeline-comment-created",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}