Skip to main content

list notification messages

GET 
/org/:orgId/notificationMessage

List or search the notification messages of the given organization with pagination.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Query Parameters

    limit integer

    List pagination size, default 1000, max value is 1000

    keyword string

    Keyword to search in subject/content

    offset integer

    List pagination offset, default 0

Responses​

OK

Schema

    nextOffset integer

    The next offset to use in the next request to get the next page of notification messages. If this field is null, there are no more notification messages to get.

    notificationMessages

    object[]

  • Array [

    • creationTime date-time

    CreationTime holds the value of the "creation_time" field.

    id string

    ID of the ent.

    info

    object

    action NotificationEventAction (string)

    Possible values: [``, ABNORMAL_ALERT, ACCEPT, ADD, APPROVE, CANCEL, CLOSE, CREATE, DELETE, ARCHIVE, VOID, DISBURSE, END_SOON, EXPIRE, EXPIRE_SOON, MERGE, METER, NEW_CLIENT_SIGNUP, NOTIFY, NOTIFY_CONTACTS, OPEN_EMAIL, PENDING_CANCEL, PENDING_ACCEPTANCE, REINSTATE, REJECT, REOPEN, CHARGE, REFUND, ISSUE, SIGN, PENDING_PARTNER_ACTION, ROTATE_SECRET, SUSPEND, TEST, UPDATE, SUBMIT_APPROVAL_REQUEST, REVIEW_APPROVAL_REQUEST, COMPLETE, FAIL, WEBHOOK, INBOUND]

    The action of this notification message.

    ccRecipients string[]

    customFields

    object

    All other fields

    property name* any

    All other fields

    htmlContent string

    The HTML content of the email.

    rccRecipients string[]

    standardFields

    object

    The standard fields to render the email content.

    property name* any

    The standard fields to render the email content.

    subject string
    textContent string

    The text content of the email in case the recipient's email client does not support HTML.

    organizationID string

    OrganizationID holds the value of the "organization_id" field.

    recipient string

    supports multiple recipients as a comma-separated string

    type github_com_sugerio_marketplace-service_pkg_orm_notificationmessage.Type (string)

    Possible values: [EMAIL, SLACK, SMS, SNS, WEBHOOK, SUGER_SUPPORT, MICROSOFT_TEAMS]

  • ]

    • totalCount integer

    The total number of notification messages. Only available when the request is made with the first offset = 0.

Loading...