/notifications
/groups
Add event
Adds a notification event to a channel for a group. | authz: min_org_role=administrator | () -> (bool)
post/notifications/groups/add_event/v1/{group_id}/{channel}/{event}
Path parameters
group_idstring required
channel'email' | 'sms' | 'push' required
Notification delivery channels.
event'shipping.order.staged' | 'shipping.order.completed' | 'shipping.order.cancelled' | 'shipping.task_group.provider_assigned' | 'shipping.task_group.in_progress' | 'shipping.task_group.file_added' | 'shipping.task_group.driver_assigned' | 'shipping.task_group.message' | 'shipping.task_group.tasks_ordering_updated' | 'shipping.task_group.flight_info_updated' | 'shipping.task.added' | 'shipping.task.attempted' | 'shipping.task.completed' | 'shipping.task.skipped' | 'shipping.task.deleted' | 'shipping.task.task_artifact_completed' | 'shipping.task.executor_org_note_added' | 'listing.listing.driver_invited_to_bid' | 'listing.listing.provider_invited_to_bid' | 'listing.bid_thread.action_added' | 'operations.order.operator_assigned' | 'operations.order.department_assigned' | 'operations.order_internal_messages.message' | 'operations.order_internal_messages.file_added' | 'billing.invoice.approved' | 'tracking.session.geofence_entered' | 'shipping_integration.order.staged' | 'shipping_integration.order.in_progress' | 'shipping_integration.order.completed' | 'shipping_integration.order.exception' | 'shipping_integration.order.cancelled' required
All notification events available at the org level. Controlled by Groups that admins configure. Individual users in the group can opt out.
Response
Successful Response
boolean required
Changes
No recorded changes to this endpoint across all 1 revision of this API.