Skip to content
This repository was archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
27 lines (24 loc) · 3.84 KB

Notification.md

File metadata and controls

27 lines (24 loc) · 3.84 KB

Bfwd::Notification

Properties

Name Type Description Notes
created DateTime { "description" : "The UTC DateTime when the object was created.", "verbs":[] } [optional]
changed_by String { "description" : "ID of the user who last updated the entity.", "verbs":[] } [optional]
updated DateTime { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } [optional]
id String { "description" : "ID of the notification.", "verbs":["POST","PUT","GET"] } [optional]
domain String { "description" : "The domain of the notification.", "verbs":["POST","PUT","GET"] }
action String { "description" : "The action associated with the notification.", "verbs":["POST","PUT","GET"] }
organization_id String { "description" : "Organization associated with the notification.", "verbs":["POST","PUT","GET"] }
webhook_id String { "description" : "Webhook associated with the notification.", "verbs":["POST","PUT","GET"] }
entity_id String { "description" : "The id of the entity associated with the notification.", "verbs":["POST","PUT","GET"] }
destination_url String { "description" : "The URL the notification will be sent to.", "verbs":["POST","PUT","GET"] }
format String { "description" : "Format of the notification.", "verbs":["POST","PUT","GET"] }
ack_enabled BOOLEAN { "description" : "If true notifications will continue to be sent until an acknowledgment is received.", "verbs":["POST","PUT","GET"] } [default to false]
entity Array<String> [optional]
changes Array<String> [optional]
last_send_attempt DateTime { &quot;description&quot; : &quot;The UTC DateTime of the notifications's last send attempt.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] } [optional]
next_send_attempt DateTime { &quot;description&quot; : &quot;The UTC DateTime of the notification's next send attempt.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] } [optional]
final_send_attempt DateTime { &quot;description&quot; : &quot;The UTC DateTime of the notification's final send attempt.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] } [optional]
total_send_attempts Integer { &quot;description&quot; : &quot;The number of send attempts for this notification.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] } [optional]
state String { &quot;description&quot; : &quot;Whether the notification has been sent.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] }
acked DateTime { &quot;description&quot; : &quot;The UTC DateTime when the notification was acked if it is ack enabled.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] } [optional]