Sign in

v30

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-22116135580.0 KB
Schedules

Create schedules

Creates one or more schedules for a workflow with the specified recipients, timing, and data. Schedules can be one-time or recurring. This endpoint also handles inline identifications for the actor, recipient, and tenant fields.

post/v1/schedules

Request body

dataobject nullable

An optional map of data to pass into the workflow execution. There is a 10MB limit on the size of the full data payload. Any individual string value greater than 1024 bytes in length will be truncated in your logs.

ending_atstring date-time nullable

The ending date and time for the schedule.

scheduled_atstring date-time nullable

The starting date and time for the schedule.

workflowstring required

The key of the workflow.

Example request

{
  "data": {
    "key": "value"
  },
  "ending_at": null,
  "recipients": [
    "user_123"
  ],
  "repeats": [
    {
      "__typename": "ScheduleRepeat",
      "day_of_month": null,
      "days": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri",
        "sat",
        "sun"
      ],
      "frequency": "daily",
      "hours": null,
      "interval": 1,
      "minutes": null
    }
  ],
  "scheduled_at": null,
  "tenant": "acme_corp",
  "workflow": "comment-created"
}

Response

OK

__typenamestring

The typename of the schema.

dataobject nullable

An optional map of data to pass into the workflow execution. There is a 10MB limit on the size of the full data payload. Any individual string value greater than 1024 bytes in length will be truncated in your logs.

idstring uuid required

Unique identifier for the schedule.

inserted_atstring date-time required

Timestamp when the resource was created.

last_occurrence_atstring date-time nullable

The last occurrence of the schedule.

next_occurrence_atstring date-time nullable

The next occurrence of the schedule.

tenantstring nullable

The tenant to trigger the workflow for. Triggering with a tenant will use any tenant-level overrides associated with the tenant object, and all messages produced from workflow runs will be tagged with the tenant.

updated_atstring date-time required

The timestamp when the resource was last updated.

workflowstring required

The workflow the schedule is applied to.

Example response

[
  {
    "__typename": "Schedule",
    "actor": null,
    "data": null,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "inserted_at": "2021-01-01T00:00:00Z",
    "last_occurrence_at": null,
    "next_occurrence_at": null,
    "recipient": {
      "__typename": "User",
      "avatar": null,
      "created_at": null,
      "email": "jane@ingen.net",
      "id": "jane",
      "name": "Jane Doe",
      "phone_number": null,
      "timezone": null,
      "updated_at": "2024-05-22T12:00:00Z"
    },
    "repeats": [
      {
        "__typename": "ScheduleRepeat",
        "day_of_month": null,
        "days": [
          "mon",
          "tue",
          "wed",
          "thu",
          "fri",
          "sat",
          "sun"
        ],
        "frequency": "daily",
        "hours": null,
        "interval": 1,
        "minutes": null
      }
    ],
    "tenant": null,
    "updated_at": "2021-01-01T00:00:00Z",
    "workflow": "workflow_123"
  }
]