UPupsmith
notification-rules

Read Rule Vocabulary

What a rule may read and produce, derived from the registry.

Organization-independent: the vocabulary is the same everywhere, and what differs per organization is which recipients and campaigns its values can name.

get/notifications/rules/vocabulary

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

Response

Successful Response

event_typesstring[] required
previewable_event_typesstring[] required
dispatched_event_typesstring[] required
send_time_attributesobject required
presence_only_attributesstring[] required
follow_up_attributesstring[] required
event_type_labelsobject required
outputsstring[] required
channelsstring[] required
authorable_channelsstring[] required
default_channelsstring[] required
event_timingsobject
recipient_kindsstring[] required
sms_incapable_recipient_kindsstring[] required
call_incapable_recipient_kindsstring[] required
call_incapable_rotation_sourcesstring[] required
timingsstring[] required
escalation_delay_presetsinteger[] required
max_escalation_delay_minutesinteger required
escalation_event_typesstring[] required
escalation_step_channelsstring[] required
escalation_step_capable_channelsstring[] required
block_reasonsstring[] required

Changes

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