logo

Retrieve a customer timeline message

Retrieves a customer message with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

messageId
required
string

Customer timeline message ID.

Responses
200

Customer message retrieved.

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

ID of the customer timeline custom event.

type
string

Type of timeline message.

Enum: "account-password-reset-requested" "account-verification-requested" "aml-list-was-possibly-matched" "cashier-request-completed" "cashier-request-created" "cashier-request-expired" "cashier-request-started" "coupon-applied" "coupon-redeemed" "coupon-redemption-canceled" … 66 more
customEventType
string or null [ 1 .. 255 ] characters

Timeline custom event type. Used with custom-event type. This value must be defined using the Create customer timeline custom event type operation.

triggeredBy
string

Specifies who, or what, triggered the timeline event.

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

Detailed message description.

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 (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/customers/{id}/timeline/{messageId}
Request samples 
const message = await api.customers
    .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});
console.log(message.fields.eventType);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "account-password-reset-requested",
  • "customEventType": "string",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Delete a customer timeline message