pass.window_scheduled
A new access window came into existence on a time-limited pass plan.
When this fires
A dated access window was created on a pass plan: either generated from the plan's recurrence, or placed by hand from Manage Access Windows or the pass windows endpoint.
This is the event that lets you mirror a schedule outward without polling for it. Every other pass.* event describes something happening to a window that already exists; this one is the window arriving.
Why this matters more once a series is involved. A Pass Series can be set to absorb new windows automatically as they are scheduled, and its holders are granted them at no charge. Without this event an integration has no way to learn a season grew except by re-reading the plan: the difference between a synced calendar and a stale one.
Caveats
- Editing a schedule regenerates windows in bulk. Saving a pass plan rebuilds its unsold future windows, so a single edit can emit this many times in quick succession. Batch on your side rather than treating each as an isolated announcement.
- Regeneration never touches a window somebody bought, a window a series points at, or one a creator pinned, so those are not deleted and re-created, and do not re-emit.
source: manualwindows are never rebuilt by a schedule edit. They fire this once, when placed.- Timestamps are UTC.
timezoneis on the payload precisely so you do not have to look the plan up to render them correctly.
Related events
pass.window_opened: the same window reaching its start time.pass.window_cancelled: a window being withdrawn.pass_series.leg_added: a rule absorbing a newly-scheduled window into a live season.
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
Header Parameters
t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.
The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Payload
JSONWhat Subscriby posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on