pass_series.leg_substituted
A cancelled date in a season was replaced, and one holder was moved to the replacement.
When this fires
A creator cancelled a window that a season ticket points at, a replacement was available, and one holder was moved onto it. Their season carries on at the same length.
Fires once per holder, not once per cancellation. Each holder is resettled individually because the outcomes differ: someone already holding the replacement date skips past it to the next one they do not have, and someone with no replacement available is dropped instead.
Caveats
was_queuedis the field worth branching on. A holder who was queued stays queued for the new date and is told there is nothing to do. One who was not usually gets their invite link attached, except a holder who had already been admitted to the cancelled window: they also reportwas_queued: false, but their access is revoked and they are told a fresh link arrives when the new window opens, so no link is attached.was_queued: falsetherefore covers two different situations; if you need to tell them apart, check whether the holder currently has access. If you send your own message alongside ours, match that split or you will ask half your audience to do something they have already done.- The holder is never moved onto a date they already hold. The next one they do not have is chosen instead, so
to_window_idcan be further out than the immediate next window. - Three groups are skipped entirely and produce no event: holders who are paused, past due, or who cancelled their own series. They still paid for a date that is not happening. Check subscriptions on that plan before reaching for a refund list.
plan_idis the source plan. To identify the series, readsubscription_id.
Related events
pass.holder_moved: the same resettlement on an ordinary single-window pass rather than a series.pass_series.leg_dropped: what happens when no replacement exists.pass.window_cancelled: fires once, last, carrying both tallies.
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