list notification events by entity
GET/org/:orgId/notificationEvent/:entityType/:entityId
List the notification events of the given organization and entity.
Request
Path Parameters
Organization ID
Entity type, valid values are: PRODUCT, OFFER, ENTITLEMENT, INTEGRATION etc.
Entity ID
Query Parameters
List pagination size, default 1000, max value is 1000
List pagination offset, default 0
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
If it is nil, it means there is no more records.
notificationEvents
object[]
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
]
Cc contactIds that will receive this notification
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"]
Contact emails that will receive this notification
ContactIds that will receive this notification
createdBy
object
The email of the creator.
The ID of the creator.
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.
The name of the creator.
customFields
object
Custom fields of the notification event.
Custom fields of the notification event.
The name of the entity.
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
]
notification event id.
Possible values: [``, SCHEDULED
, PENDING
, DONE
, FAILED
]
Additional info of the notification event.
If this notification event is an action item.
timestamp of the event when it is updated.
The message of the notification event such as email body, action item description.
suger organization id.
Possible values: [``, ADYEN
, ALIBABA
, AWS
, AWS_CHINA
, AZURE
, GCP
, GOOGLE
, HUBSPOT
, LAGO
, MARKETO
, METRONOME
, MICROSOFT
, ORACLE
, ORB
, REDHAT
, SALESFORCE
, SLACK
, STRIPE
, ZOHO
]
Possible values: [``, LOW
, MEDIUM
, HIGH
, CRITICAL
]
If this notification event is an auditing event and need to store in DB.
timestamp of the event when it is scheduled or created.
The title of the notification event such as email subject, action item title.
trackEvents
object[]
The track events of the notification event.
Possible values: [OPEN_EMAIL
]
The ID of the contact who triggered the track event if applicable.
timestamp of the track event happened.
Only available when the request is made with offset=0.
{
"nextOffset": 0,
"notificationEvents": [
{
"action": "",
"ccContactIds": [
"string"
],
"channels": [
"EMAIL"
],
"contactEmails": [
"string"
],
"contactIds": [
"string"
],
"createdBy": {
"email": "string",
"entityId": "string",
"entityType": "",
"name": "string"
},
"customFields": {},
"entityID": "string",
"entityName": "string",
"entityStatus": "string",
"entityType": "",
"eventID": "string",
"eventStatus": "",
"isActionItem": true,
"lastUpdateTime": "2024-08-12T01:02:13.916Z",
"message": "string",
"organizationID": "string",
"partner": "",
"priority": "",
"requireAudit": true,
"timestamp": "2024-08-12T01:02:13.916Z",
"title": "string",
"trackEvents": [
{
"action": "OPEN_EMAIL",
"contactId": "string",
"timestamp": "2024-08-12T01:02:13.917Z"
}
]
}
],
"totalCount": 0
}
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string