Notifications

Test a notification settings object.

This will send test notifications to a specific notification target

  • Requires the action org:LoadNotificationSettings on the organization.
post/api/v1/org/{orgUID}/test_notification

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/test_notification
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Request body

notification_settings_uidstring

The notification settings UID to test.

recordobject

Record is the data to use when testing the notification. Fields in the record can be dereferenced by the template. For saved query notifications this will be the model or event record that matched the query.

target_uidstring

The target UID to test.

template_uidstring

The template UID to test.

Response

OK

messagestring

Contains information on inspecting the success or failure of the test notification.

Changes

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