Skip to main content

list notification events

GET 
/org/:orgId/notificationEvent

List the notification events of the organization by given priorities.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Query Parameters

    startDate string

    start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate

    endDate string

    end date (UTC) in YYYY-MM-DD format, default is today

    limit integer

    List pagination size, default 1000, max value is 1000

    offset integer

    List pagination offset, default 0

    priorities string

    Filter by priorities, empty means all priorities. Valid values are: LOW, MEDIUM, HIGH, CRITICAL. Multiple values are supported, separated by comma.

Responses​

OK

Schema

    nextOffset integer

    If it is nil, it means there is no more records.

    notificationEvents

    object[]

  • Array [

    • action NotificationEventAction (string)

    Possible values: [``, ABNORMAL_ALERT, ACCEPT, ADD, APPROVE, CANCEL, CLOSE, CREATE, DELETE, DISBURSE, END_SOON, EXPIRE, EXPIRE_SOON, METER, NEW_CLIENT_SIGNUP, NOTIFY, NOTIFY_CONTACTS, OPEN_EMAIL, PENDING_CANCEL, PENDING_ACCEPTANCE, REINSTATE, REJECT, REOPEN, CHARGE, REFUND, ISSUE, ROTATE_SECRET, SUSPEND, TEST, UPDATE]

    ccContactIds string[]

    Cc contactIds that will receive this notification

    channels NotificationChannel (string)[]

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

    The list of channels this event will be sent to, e.g., ["SLACK", "EMAIL"]

    contactEmails string[]

    Contact emails that will receive this notification

    contactIds string[]

    ContactIds that will receive this notification

    createdBy

    object

    email string

    The email of the creator.

    entityId string

    The ID of the creator.

    entityType EntityType (string)

    Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]

    The Entity type of the creator, either USER or API_CLIENT.

    name string

    The name of the creator.

    customFields

    object

    Custom fields of the notification event.

    property name* any

    Custom fields of the notification event.

    entityID string
    entityName string

    The name of the entity.

    entityStatus string
    entityType EntityType (string)

    Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]

    eventID string

    notification event id.

    eventStatus NotificationEventStatus (string)

    Possible values: [``, SCHEDULED, PENDING, DONE, FAILED]

    info

    Additional info of the notification event.

    isActionItem boolean

    If this notification event is an action item.

    lastUpdateTime date-time

    timestamp of the event when it is updated.

    message string

    The message of the notification event such as email body, action item description.

    organizationID string

    suger organization id.

    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]

    priority AuditingEventPriority (string)

    Possible values: [``, LOW, MEDIUM, HIGH, CRITICAL]

    requireAudit boolean

    If this notification event is an auditing event and need to store in DB.

    timestamp date-time

    timestamp of the event when it is scheduled or created.

    title string

    The title of the notification event such as email subject, action item title.

    trackEvents

    object[]

    The track events of the notification event.

  • Array [

    • action TrackEventActionType (string)

    Possible values: [OPEN_EMAIL]

    contactId string

    The ID of the contact who triggered the track event if applicable.

    timestamp date-time

    timestamp of the track event happened.

  • ]

  • ]

    • totalCount integer

    Only available when the request is made with offset=0.

Loading...