OMomni
Schedules

Trigger schedule

Changed on

Trigger the execution of a schedule on demand, outside of its regular schedule.

post/v1/schedules/{scheduleId}/trigger

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/schedules/{scheduleId}/trigger
  • Auth
    HTTP bearer

Path parameters

scheduleIdstring uuid required

The ID of the schedule. To find a schedule's ID:

  1. Navigate to the dashboard or workbook.
  2. Click File > Deliveries & Alerts.
  3. Next to a schedule, click Edit.

The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:

https://blobsrus.omniapp.co/dashboards/e23ebaa0/schedules/123e4567-e89b-12d3-a456-426614174000

Response

Schedule triggered successfully

successboolean

Example response

{
  "success": true
}

Changes

  • 43290040f88fRevision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status