Skip to main content
POST
/
v1
/
schedules
/
{scheduleId}
/
trigger
Trigger schedule
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/schedules/{scheduleId}/trigger \
  --header 'Authorization: Bearer <token>'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
scheduleId
string<uuid>
required

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

  1. Navigate to the dashboard of a document.
  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

​
success
boolean
Example:

true