Search
K
notifications v1

Error

object

Detailed error related to the API

codestring

The error code.

  • GA.LODGE.??? - Subscriber profile has been suspended or terminated

Example:GA.LODGE.001

Example

NotificationEvent

object
notificationIdstring(uuid)

The unique ID(UUID) for each notification message(aka ‘event’)

subscriberIdstring

The ID of the subscriber (can be UUID or just integer)

Example:123456789

attemptsarray[object]

The array of attempts for each notification

Show Child Parameters
Example

NotificationEventAttempt

object
responseCodeinteger

The HTTP response code from webhook

Example:500

responseBodystring

The response body from webhook

attemptTimestring

The timestamp of attempt sent to webhook

Example:2023-12-18T20:38:59Z

Example

NotificationList

object
notificationEventsarray[object]
Show Child Parameters
totalPagesinteger

Default:0

Example

ResendRegistrationResponse

object

Failed Notification details

notificationIdstring

The notification ID returned by the POST /v1/notifications/{notificationId}/retry-notifications endpoint

Example:c673eb32-82c6-42fc-9c74-54498ce4eb4e

notificationStatusstring

The status of the notification

Example:SENT

detailsstring

The description of the error

Example:Retry successful

Example