notification-rules

Preview Rule

Run a draft against real events without storing it.

Organization admin rather than member, although it stores nothing. It evaluates an arbitrary caller-supplied document against this organization's real escalations and calls and reports what it read, which is an authoring capability; a member who may read the rules list has not thereby been given it.

Declared before /{rule_key} has no bearing -- there is no POST /{rule_key} -- but it stays with the other literal paths so the file reads in one order.

post/notifications/rules/preview

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

decisionobject required
event_typestring nullable
limitinteger

Response

Successful Response

event_sourcestring required

Changes

No recorded changes to this operation across all 1 revision of this API.