Retrieve the Notification History for a LinX Workflow

Retrieve details for the Customer notifications that have been generated for the workflow.

Endpoint

GET /v2/linx/workflows/{workflowId}/notifications/history

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

workflowId REQUIRED

string (UUID)

ID of the LinX workflow.

Request Body

None

Returns

Returns details for each Customer notification created for the workflow. The following fields are returned.

serial

integer

The notification sequence. The initial notification (generated when the workflow was created) will have a value of 0. Subsequent notifications will be numbered sequentially (1, 2, 3, etc.).

channel

string enum, values: SMS

Notification method used to send the request to the Customer.

origin

string enum, values: INITIAL, MANUAL, REMINDER, EXPIRY

Event that originated the notification. Possible values are:

INITIAL Initial notification generated when the workflow was created.
MANUAL Notification was resent using the RocketKOR Portal or the Resend Workflow API.
REMINDER Reminder notification sent to the Customer.
EXPIRY Notification informing the Customer that the request has expired.

notifiedBy

object

Entity that sent the notification.

string (UUID)

ID of the entity. Will be blank if notifiedBy.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

notifiedAt

string (date-time)

Date and time the notification was sent.

SAMPLE RESPONSE

				
					{
  "serial": 0,
  "channel": "SMS",
  "origin": "INITIAL",
  "notifiedBy": {
    "id": "df37006b-c058-4128-b020-362eccc6801b",
    "type": "employee"
  },
  "notifiedAt": "2023-11-09T21:00:49.776302Z"
}