Skip to main content

Get Schedule Action

The Get Schedule action retrieves a schedule (product option) by ID and adds it to the workflow context.

Jerome Bajou avatar
Written by Jerome Bajou
Updated over a week ago

Overview

The Get Schedule action retrieves a schedule (product option) by ID and adds it to the workflow context.


Configuration

Schedule ID (Required)

The ID of the schedule to retrieve. Supports variables.

Examples:

{schedule.id} 
{availability.bookable_id}
{webhook_payload.schedule_id}

Output

Adds a schedule object to the workflow context with all schedule details:

  • Basic information (id, uuid, name, option_code)

  • Product relationship (product_id)

  • Capacity and traveler limits

  • Age restrictions

  • Pricing and refund settings

  • Cut-off time information

Accessing Schedule Data

After this action, you can access:

{schedule.id} 
{schedule.name}
{schedule.option_code}
{schedule.product_id}
{schedule.capacity}
{schedule.min_age}
{schedule.max_age}
{schedule.min_travelers}
{schedule.max_travelers}
{schedule.is_refundable}
{schedule.color}
{schedule.cut_off_time}

Use Cases

  • Retrieve schedule details from booking

  • Get schedule information from availability

  • Access schedule for capacity checks

  • Load schedule for pricing calculations

  • Validate schedule constraints


Examples

1. From Availability

Workflow:

  1. Booking Confirmed trigger

  2. Get Schedule ({booking.availability.bookable_id})

  3. Check capacity ({schedule.capacity})

  4. Send notification with schedule details

2. From Webhook

Workflow:

  1. Webhook trigger

  2. Get Schedule ({payload.schedule_id})

  3. Validate age restrictions ({schedule.min_age}, {schedule.max_age})

  4. Process booking with schedule constraints

3. Capacity Validation

Workflow:

  1. Booking Changed trigger

  2. Get Schedule ({booking.availabilities.0.bookable_id})

  3. Check if capacity allows update

  4. Update booking or send notification


Best Practices

  1. Verify ID exists - Check schedule ID before using

  2. Handle not found - Set up error handling for invalid schedule IDs

  3. Use with product - Combine with Get Product action for complete product information

  4. Check constraints - Validate age and traveler limits before processing


Related Documentation

Did this answer your question?